[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 370 > < TAKE 250 >
250 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCCore.ARConcepts.DataRetention | ARCCore | EnumMember | The concept of when to delete old data (if deemed necessary). |
| ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
| ARCCore.InvalidTypeException | ARCCore | Class | |
| ARCCore.IP.OnTrySetP | ARCCore | ClassMember | Event handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done). |
| ARCCore.ARConcepts.NoRealDeletion | ARCCore | EnumMember | AgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data). |
| ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
| ARCCore.InvalidTypeException.AssertAssignable | ARCCore | ClassMember | Asserts that expectedType.IsAssignableFrom(foundType) |
| ARCCore.IP.TryGetP Overload1 | ARCCore | ClassMember | Gets a single property for this object |
| ARCCore.ARConcepts.ManyToManyRelations | ARCCore | EnumMember | -ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table). |
| ARCDoc.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
| ARCCore.InvalidTypeException.AssertEquals | ARCCore | ClassMember | Asserts that expectedType.Equals(foundType) |
| ARCCore.IP.ToPropertyStream | ARCCore | ClassMember | Turns object into a -PropertyStream- |
| ARCCore.ARConcepts.Documentation | ARCCore | EnumMember | Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
| ARCCore.ClassAttributeP.ClassType | ARCCore | EnumMember | The actual type that we are a -ClassAttribute- for |
| ARCCore.IP.TryGetPV | ARCCore | ClassMember | Gets a single property's value for the given property key. |
| ARCCore.PKRelAttributeP.ForeignEntity | ARCCore | EnumMember | The type of foreign entity that this property points to. |
| ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| ARCCore.ClassAttributeP.BaseTypes | ARCCore | EnumMember | The inheritance hierarchy for this class, starting with base type (excluding 'object').r Not set if class does not inherit any class except 'object' |
| ARCCore.IP.EnumeratorReturnsEmptyCollection | ARCCore | ClassMember | Hint for how to avoid calling enumerator.Count() when all you need is to decide if collection is empty or not. |
| ARCCore.PKRelAttributeP.EnforceReferentialIntegrity | ARCCore | EnumMember | If TRUE then referential integrity will be enforced by -TryStore-. |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| ARCCore.ClassAttributeP.SubTypes | ARCCore | EnumMember | Direct and indirect sub types of this class. |
| ARCCore.IP.IsValid | ARCCore | ClassMember | Note that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'. |
| ARCCore.PKTypeAttributeP | ARCCore | Enum | Describes class -PKTypeAttribute-. |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| ARCCore.ClassAttributeP.Interfaces | ARCCore | EnumMember | All interfaces that this class and its base classes implement |
| ARCCore.IP.Item | ARCCore | ClassMember | Offers string-based direct indexing. |
| ARCCore.PKTypeAttributeP.Type | ARCCore | EnumMember | The type of this Property. |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| ARCCore.ClassAttributeP.InterfacesDirectlyImplemented | ARCCore | EnumMember | All interfaces that this class directly implements. |
| ARCCore.PCollection | ARCCore | Class | A class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-. |
| ARCCore.PKTypeAttributeP.DefaultValue | ARCCore | EnumMember | The default value. |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCCore.ClassAttributeP.CorrespondingEnumType | ARCCore | EnumMember | Only relevant when implements -IP-. |
| ARCCore.PCollection.TrySetPP | ARCCore | ClassMember | Replaces default interface method -TrySetPP-. |
| ARCCore.PKTypeAttributeP.Cardinality | ARCCore | EnumMember | Describes how multiple instances of a property is supposed to be handled. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCCore.ClassAttributeP.BoilerplateCodePropertiesAndStorage | ARCCore | EnumMember | Only relevant when implements -IP- and when a -CorrespondingEnumType- is found. |
| ARCCore.PCollection.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCCore.PKTypeAttributeP.IsObligatory | ARCCore | EnumMember | True means value is obligatory. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| ARCCore.ClassMemberAttributeP | ARCCore | Enum | Describes class -ClassMemberAttribute-. |
| ARCCore.PCollection.TryGetV | ARCCore | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCCore.PKTypeAttributeP.BoilerplateCodeProperties | ARCCore | EnumMember | Automatically generated boilerplate code that implements traditional setters and getters for this key. |
| ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
| ARCCore.ARComponents.ARCDoc | ARCCore | EnumMember | A library supporting documentation and demonstrating usage of AgoRapide. |
| ARCCore.PKLogAttributeP.DoNotLogAtAll | ARCCore | EnumMember | Originates from -DoNotLogAtAll-. |
| ARCCore.PP.ExceptionText | ARCCore | EnumMember | General property for logging of exceptions, usually set through -HandleException-. |
| ARCDoc.DocLinkResolution.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCCore.ARComponents.ARCQuery | ARCCore | EnumMember | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. |
| ARCCore.PKLogAttributeP.CountInterval | ARCCore | EnumMember | For a value of n, log only every n'th time the property is changed. |
| ARCCore.PConcurrentP | ARCCore | Enum | Describes class -PConcurrent-. |
| ARCDoc.DocLinkResolution.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ARComponents.ARCSync | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.PKLogAttributeP.TimeInterval | ARCCore | EnumMember | Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-. |
| ARCCore.PConcurrentP.Heartbeat | ARCCore | EnumMember | |
| ARCDoc.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
| ARCCore.ARComponents.ARCSec | ARCCore | EnumMember | (Not implemented as of March 2020) |
| ARCCore.PKRelAttributeP | ARCCore | Enum | Describes class -PKRelAttribute-. |
| ARCCore.ActualConnectionP | ARCCore | Enum | Describes class -ActualConnection-. |
| ARCDoc.DocLinkResolutionCollection.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCCore.ARComponents.ARCAPI | ARCCore | EnumMember | A library providing an API on top of the -PropertyStream-. |
| ARCCore.PP | ARCCore | Enum | Describes meta data for any class (property) implementing -IP-. |
| ARCCore.ActualConnectionP.Id | ARCCore | EnumMember | When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection. |
| ARCDoc.DocLinkResolutionCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ARComponents.ARAAPI | ARCCore | EnumMember | The corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc. |
| ARCCore.PP.Created | ARCCore | EnumMember | Timestamp when property was created in database. |
| ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
| ARCDoc.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
| ARCCore.ARConcepts | ARCCore | Enum | The overarching concepts upon which AgoRapide is built. |
| ARCCore.PP.Cid | ARCCore | EnumMember | Creator id (entity which created this property). |
| ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
| ARCDoc.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
| ARCCore.ARConcepts.GettingStarted | ARCCore | EnumMember | AgoRapide 2020 is an open source library for building data-oriented backend applications using .NET Standard 2.1. |
| ARCCore.PP.Value | ARCCore | EnumMember | The actual value. |
| ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
| ARCDoc.Documentator.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages | ARCCore | EnumMember | The abstraction level in AgoRapide is very high. |
| ARCCore.PP.Valid | ARCCore | EnumMember | Timestamp when property was last known to be (still) valid |
| ARCCore.ActualConnectionP.IsErrorCondition | ARCCore | EnumMember | Some kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound. |
| ARCDoc.Documentator.CreateHTOCStandard | ARCDoc | ClassMember | Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'. |
| ARCCore.ARConcepts.ExposingApplicationState | ARCCore | EnumMember | The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool. |
| ARCCore.PP.Vid | ARCCore | EnumMember | Validator id, that is entity which set -Valid- for this property. |
| ARCCore.ActualConnectionP.ErrorConditionData | ARCCore | EnumMember | Detailed explanation about -IsErrorCondition- |
| ARCDoc.Documentator.CreateHTOCNamespace | ARCDoc | ClassMember | Creates a table of contents structured by namespace |
| ARCCore.ARConcepts.LinkInsertionInDocumentation | ARCCore | EnumMember | Documentation with links is much easier to read. |
| ARCCore.PP.Invalid | ARCCore | EnumMember | Timestamp when property was invalidated / 'deleted'. |
| ARCCore.ActualConnectionP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed and reinitialized. |
| ARCDoc.Documentator.CreateHTOCInheritance | ARCDoc | ClassMember | Creates a table of contents structured by inheritance (classes and interfaces only, not members). |
| ARCCore.ARConcepts.TryPatternAndNull | ARCCore | EnumMember | AgoRapide uses non-nullable reference types as default throughout the system |
| ARCCore.PP.Iid | ARCCore | EnumMember | Invalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01'). |
| ARCCore.ActualConnectionP.MonkeyWrench | ARCCore | EnumMember | |
| ARCDoc.Documentator.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCCore.AREnumType | ARCCore | Enum | Categories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-. |
| ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
| ARCDoc.Documentator.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.AREnumType.PropertyKeyEnum | ARCCore | EnumMember | Designates enums that describe relevant values for an 'entity' object like 'Customer'. |
| ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
| ARCDoc.Documentator.DocLinks | ARCDoc | ClassMember | Set by -CreateAndInsert-. |
| ARCCore.AREnumType.OrdinaryEnum | ARCCore | EnumMember | Designates "Ordinary" enums used for indicating range of valid values for a given key |
| ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
| ARCCore.ConnectionInstructionP.ClientId | ARCCore | EnumMember | The AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to. |
| ARCDoc.Documentator.DocLinkResolutionLocation | ARCDoc | ClassMember | Default position within the global storage context of doc link resolution pages. |
| ARCCore.AREnumType.DocumentationOnlyEnum | ARCCore | EnumMember | Designates enums that provide a central repository of explanation of terms that are not present in the C# code. |
| ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
| ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
| ARCDoc.DummyEnum | ARCDoc | Class | TODO: Document better what this is for (and change name) |
| ARCQuery.FunctionKeyDayOfWeek.SyntaxHelp | ARCQuery | ClassMember | 'DayOfWeek()' |
| ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
| ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
| ARCDoc.UtilDoc | ARCDoc | Class | Utility methods for -ARCDoc-. |
| ARCQuery.FunctionKeyDouble | ARCQuery | Class | Converts an integer to a double (decimal value). |
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
| ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTML | ARCDoc | ClassMember | Returns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy. |
| ARCQuery.FunctionKeyDouble.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
| ARCDoc.UtilDoc.GenerateHTMLPage | ARCDoc | ClassMember | Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS. |
| ARCQuery.FunctionKeyDouble.SyntaxHelp | ARCQuery | ClassMember | 'Double()' |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| ARCCore.StreamProcessorP.CountOutgoingConnections | ARCCore | EnumMember | |
| ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
| ARCQuery.FunctionKeyFirstLine | ARCQuery | Class | Extracts first line from string of text. |
| ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
| ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
| ARCQuery.FunctionKeyFirstLine.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
| ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
| ARCQuery.FunctionKeyFirstLine.SyntaxHelp | ARCQuery | ClassMember | 'FirstLine()' |
| ARCCore.StreamProcessorP.DoNotStoreLocally | ARCCore | EnumMember | For -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-. |
| ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
| ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
| ARCQuery.FunctionKeyHourMinute | ARCQuery | Class | Formats a timespan with only the hour and minute part. Uses format hh:mm. |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
| ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
| ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCCore.StorageFileP.Hash | ARCCore | EnumMember | Hash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCDoc.Apple.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCCore.DataTransferDirection.Send | ARCCore | EnumMember | Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-. |
| ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
| ARCDoc.DocFrag.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
| ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
| ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
| ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
| ARCDoc.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
| ARCDoc.DocFragCollection.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
| ARCDoc.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
| ARCDoc.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
| ARCDoc.DocLink.AHrefEndPart | ARCDoc | ClassMember | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
| ARCDoc.DocLink.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
| ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
| ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
| ARCDoc.DocLinkCollection.InsertLinks | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
| ARCDoc.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.DocLinkCollection.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
| ARCDoc.DocLink.LinkWordHTMLBeforeLt | ARCDoc | ClassMember | If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'. |
| ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
| ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens | ARCDoc | ClassMember | -LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.DummyEnum.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
| ARCDoc.DummyEnum.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
| ARCDoc.Extensions | ARCDoc | Class | Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML. |
| ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
| ARCDoc.Extensions.ToHTMLSimpleSingleRecursive | ARCDoc | ClassMember | Calls -ToHTMLSimpleSingle- recursively. |
| ARCDoc.HLocation.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.Extensions.ToHTMLSimpleSingle | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter. |
| ARCDoc.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Extensions.ToHTMLSimpleSingleInternal | ARCDoc | ClassMember | Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-. |
| ARCDoc.HLocation.Content | ARCDoc | ClassMember | The Content object is not stored within the standard -IP--mechanism. |
| ARCDoc.Extensions.ToHTMLSimpleAsTableRow | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table. |
| ARCDoc.HLocationCollection | ARCDoc | Class | Contains a collection of -HLocation- objects. |
| ARCDoc.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
| ARCDoc.HLocationCollection.Create | ARCDoc | ClassMember | Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects. |
| ARCDoc.HTOC.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk | ARCDoc | ClassMember | Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-. |
| ARCDoc.HTOC.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HLocationCollection.TryGetV | ARCDoc | ClassMember | Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values). |
| ARCDoc.HTOC.HTOCContentThisLevelKey | ARCDoc | ClassMember | The key used for storing the actual content at this level. |
| ARCDoc.HLocationCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.PKDocAttribute | ARCDoc | Class | Describes documentation and presentation of a property. |
| ARCDoc.HTOC | ARCDoc | Class | HTOC = Hierarchical table of contents. |
| ARCDoc.PKDocAttribute.Initialize | ARCDoc | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCDoc.HTOC.Create | ARCDoc | ClassMember | Structures content hierarchically according to the criteria for each level. |
| ARCDoc.PKDocAttribute.TryRemoveP | ARCDoc | ClassMember | Should probably never be used. |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload2 | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.PKDocAttribute.PriorityOrder | ARCDoc | ClassMember | See -PriorityOrder-. |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload1 | ARCDoc | ClassMember | Use this method in any class where a table-of-contents type of view is desireable |
| ARCDoc.PKDocAttribute.IsDefault | ARCDoc | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCDoc.HTOC.CreateInitialContent | ARCDoc | ClassMember | Helper method for creation of a -FilterBranch-. |
| ARCDoc.DocFragP | ARCDoc | Enum | Describes class -DocFrag-. |
| ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
| ARCDoc.DocFragP.DocFragType | ARCDoc | EnumMember | |
| ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
| ARCDoc.DocFragP.Assembly | ARCDoc | EnumMember | Name of the assembly in which this fragment resides. |
| ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
| ARCDoc.DocFragP.Namespace | ARCDoc | EnumMember | Namespace in which this fragment resides. |
| ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
| ARCDoc.DocFragP.ParentNamespace | ARCDoc | EnumMember | Parent namespace of namespace in which this fragment resides. |
| ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
| ARCDoc.DocFragP.Type | ARCDoc | EnumMember | Type of class or enum which this fragment describes (also relevant for class or enum member). |
| ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
| ARCDoc.DocFragP.Name | ARCDoc | EnumMember | As simple a name as practical usable. Often not unique within a greater context. |
| ARCDoc.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
| ARCDoc.DocFragP.IsInherited | ARCDoc | EnumMember | Relevant for class members. TRUE if method is inherited from a base type. |
| ARCDoc.DocFragType.ClassMember | ARCDoc | EnumMember | |
| ARCDoc.DocLinkResolutionP.DocLinks | ARCDoc | EnumMember | The possible links for -LinkWord- |
| ARCDoc.DocFragType.Enum | ARCDoc | EnumMember | |
| ARCDoc.DocumentatorP | ARCDoc | Enum | Describes class -Documentator-. |
| ARCDoc.DocFragType.EnumMember | ARCDoc | EnumMember | |
| ARCDoc.DummyEnumP | ARCDoc | Enum | TODO: Document better what this is for (and change name) |
| ARCDoc.DocLinkP | ARCDoc | Enum | Describes class -DocLink-. |
| ARCDoc.DummyEnumP._MemberInherited | ARCDoc | EnumMember | Contains not only members which are inherited in the object-oriented sense, but also overrides for which the only documentation was found in base class |
| ARCDoc.DocLinkP.Location | ARCDoc | EnumMember | The location that this link points to. |
| ARCDoc.HLocationP | ARCDoc | Enum | Describes class -HLocation-. |
| ARCDoc.DocLinkP.Filename | ARCDoc | EnumMember | |
| ARCDoc.HLocationP.Location | ARCDoc | EnumMember | Folder names / hierarchical levels. |
Generated 2025-11-06 02:04:31.505 UTC