[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 369  >   <  TAKE 240  >   

240 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.PSPrefix.dtrARCCoreEnumMemberData, whole records.
ARCCore.ARConcepts.PropertyAccessARCCoreEnumMemberThe general mechanism for accessing properties of objects in AgoRapide.
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCCore.PSPrefix.RSARCCoreEnumMemberRS = Registration Stream (see -RegStream-).
ARCCore.ARConcepts.AvoidingRepetitionARCCoreEnumMemberAvoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.PSPrefix.ESARCCoreEnumMemberES = Event Stream (see -EventStream-).
ARCCore.ARConcepts.AgoRapideHistoryARCCoreEnumMemberAgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.PSPrefix.cmdARCCoreEnumMemberCommand.
ARCCore.ARConcepts.AdHocQueryARCCoreEnumMemberThe concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.PSPrefix.appARCCoreEnumMemberApplication state, like app/
ARCCore.ARConcepts.StandardAgoRapideCodeARCCoreEnumMemberCode originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCCore.PSPrefix.docARCCoreEnumMemberDocumentation.
ARCCore.ARConcepts.ApplicationSpecificCodeARCCoreEnumMemberCode specific for an end-application.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.PSPrefix.tARCCoreEnumMemberTranslations.
ARCCore.ARConcepts.MemoryConsumptionARCCoreEnumMemberA naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption.
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.PKHTMLAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCCore.ARConcepts.IndexingARCCoreEnumMemberIn-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-.
ARCCore.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.ARConcepts.LinkInsertionInDocumentationARCCoreEnumMemberDocumentation with links is much easier to read.
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCCore.ARConcepts.TryPatternAndNullARCCoreEnumMemberAgoRapide uses non-nullable reference types as default throughout the system
ARCCore.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCCore.AREnumTypeARCCoreEnumCategories different types of enum used in AgoRapide. The most important one is -PropertyKeyEnum-.
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCCore.AREnumType.PropertyKeyEnumARCCoreEnumMemberDesignates enums that describe relevant values for an 'entity' object like 'Customer'.
Assembly ARCDoc AssemblyA library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.ActualConnectionP.ErrorConditionDataARCCoreEnumMemberDetailed explanation about -IsErrorCondition-
ARCCore.AREnumType.OrdinaryEnumARCCoreEnumMemberDesignates "Ordinary" enums used for indicating range of valid values for a given key
ARCDoc.AppleARCDocClassThe most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCCore.ActualConnectionP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed and reinitialized.
ARCCore.AREnumType.DocumentationOnlyEnumARCCoreEnumMemberDesignates enums that provide a central repository of explanation of terms that are not present in the C# code.
ARCDoc.Apple.AddNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ActualConnectionP.MonkeyWrenchARCCoreEnumMember 
ARCCore.ARNodeTypeARCCoreEnumDescribes what function a node in an AgoRapide system serves. A given node may constitute of only -StandardAgoRapideCode- or a combination of -StandardAgoRapideCode- and -ApplicationSpecificCode-.
ARCDoc.Apple.GetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ActualConnectionP.PartnerIPAddressARCCoreEnumMemberTODO: Use more strongly typing for this.
ARCCore.ARNodeType.CoreDBARCCoreEnumMemberA node containing the core or central database.
ARCDoc.Demonstrator.DemonstrateLogConsoleARCDocClassMemberDemonstrates a quite simple log console.
ARCCore.ConnectionInstructionPARCCoreEnumDescribes class -ConnectionInstruction-.
ARCCore.PKRelAttributeP.EnforceReferentialIntegrityARCCoreEnumMemberIf TRUE then referential integrity will be enforced by -TryStore-.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClientARCDocClassMemberDemonstrates use of -StreamProcessor- as a general client.
ARCCore.ConnectionInstructionP.ClientIdARCCoreEnumMemberThe 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.
ARCCore.PKTypeAttributePARCCoreEnumDescribes class -PKTypeAttribute-.
ARCDoc.OrangeARCDocClassInherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCCore.ConnectionInstructionP.ServerHostNameARCCoreEnumMemberThe host (DNS or IP-address) for which to connect.
ARCCore.PKTypeAttributeP.TypeARCCoreEnumMemberThe type of this Property.
ARCDoc.Orange.SetPVDirectARCDocClassMemberHigh performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCCore.ConnectionInstructionP.ServerPortNoARCCoreEnumMemberThe port number for which to connect.
ARCCore.PKTypeAttributeP.DefaultValueARCCoreEnumMemberThe default value.
ARCDoc.Orange.GetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.ConnectionInstructionP.ConnectionIdARCCoreEnumMemberUsually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-.
ARCCore.PKTypeAttributeP.CardinalityARCCoreEnumMemberDescribes how multiple instances of a property is supposed to be handled.
ARCDoc.Orange.TryGetPVDirectARCDocClassMemberHigh performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.ConnectionInstructionP.DataTransferDirectionARCCoreEnumMember 
ARCCore.PKTypeAttributeP.IsObligatoryARCCoreEnumMemberTrue means value is obligatory.
ARCDoc.Orange.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ConnectionInstructionP.SubscriptionARCCoreEnumMemberThe actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server.
ARCCore.PKTypeAttributeP.BoilerplateCodePropertiesARCCoreEnumMemberAutomatically generated boilerplate code that implements traditional setters and getters for this key.
ARCDoc.Orange.NameARCDocClassMemberSee -Name- for more information.
ARCCore.ConnectionInstructionP.MultipleConnectionUsageARCCoreEnumMember 
ARCCore.PPARCCoreEnumDescribes meta data for any class (property) implementing -IP-.
ARCDoc.DocLinkCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Apple.TryGetNameARCDocClassMemberConvenience method, not obligatory.
ARCCore.PConcurrentPARCCoreEnumDescribes class -PConcurrent-.
ARCDoc.DocLinkCollection.TryGetVARCDocClassMemberNote 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.Apple.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PConcurrentP.HeartbeatARCCoreEnumMember 
ARCDoc.DocLinkCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.TryGetVARCDocClassMemberNote 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.ActualConnectionPARCCoreEnumDescribes class -ActualConnection-.
ARCDoc.DocLinkResolutionARCDocClassContains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCDoc.Apple.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.ActualConnectionP.IdARCCoreEnumMemberWhen connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
ARCDoc.DocLinkResolution.ToHTMLSimpleSingleARCDocClassMemberGives a friendly description about possible targets for LinkWord-.
ARCDoc.Apple.NameARCDocClassMemberConvenience method, not obligatory.
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCDoc.DocLinkResolution.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.BananaARCDocClassImplements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCDoc.DocLinkResolution.TryGetVARCDocClassMemberNote 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.Banana.NameARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCDoc.DocLinkResolution.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Banana.ColourARCDocClassMemberAnnotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCDoc.DocLinkResolutionCollectionARCDocClassContains a collection of -DocLinkResolution- objects.
ARCDoc.DemonstratorARCDocClassDemonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCCore.ConnectionInstructionP.ShardingARCCoreEnumMember 
ARCDoc.DocLinkResolutionCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Demonstrator.DemonstratePropertyAccessAppleARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Apple- class.
ARCCore.MultipleConnectionUsageARCCoreEnumEnables fault-tolerance by describing use of multiple connections
ARCDoc.DocLinkResolutionCollection.TryGetVARCDocClassMemberNote 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.Demonstrator.DemonstratePropertyAccessOrangeARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Orange- class.
ARCCore.MultipleConnectionUsage.AdminARCCoreEnumMemberConnection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCDoc.DocLinkResolutionCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.Demonstrator.DemonstratePropertyAccessBananaARCDocClassMemberDemonstrates use of -PropertyAccess- through the -Banana- class.
ARCCore.MultipleConnectionUsage.RoundRobinARCCoreEnumMemberThis connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCDoc.DocumentatorARCDocClassGeneral class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.Demonstrator.DemonstrateITypeDescriberARCDocClassMemberDemonstrates use of -ITypeDescriber- for describing single-property values.
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCDoc.Documentator.CreateAndInsertARCDocClassMemberCreates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorageARCDocClassMemberDemonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCDoc.Documentator.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Demonstrator.DemonstratePropertyStreamARCDocClassMemberDemonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCDoc.Documentator.CreateHTOCStandardARCDocClassMemberCreates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.Demonstrator.DemonstrateBareBonesClientARCDocClassMemberDemonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCDoc.Extensions.DescribeValueARCDocClassMemberDescribes the value contained withing an -IKIP- (-P-).
ARCDoc.DocFragCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Value with description as a 'tooltip'.
ARCDoc.DocLinkARCDocClassDescribes to where a single HTML link points.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltipARCDocClassMemberCreates a simple HTML representation of the Key with description as a 'tooltip'.
ARCDoc.DocLink.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCDoc.Extensions.GetHelptextHTMLARCDocClassMemberReturns content of -Description- and -LongDescription-.
ARCDoc.DocLink.TryGetVARCDocClassMemberNote 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.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCDoc.HLocationARCDocClassSimple class describing the location of a single -IP- instance within some hierarhical context.
ARCDoc.DocLink.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCDoc.HLocation.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLink.LocationARCDocClassMemberCopy of -Location-.
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCDoc.HLocation.TryGetVARCDocClassMemberNote 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.FilenameARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCDoc.HLocation.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.LinkWordHTMLARCDocClassMemberCopy of -LinkWordHTML-.
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCDoc.HLocation.ContentARCDocClassMemberThe Content object is not stored within the standard -IP--mechanism.
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCDoc.HLocationCollectionARCDocClassContains a collection of -HLocation- objects.
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCDoc.HLocationCollection.CreateARCDocClassMemberTransforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDiskARCDocClassMemberWrites all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCDoc.HLocationCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCCore.StorageFileP.HashARCCoreEnumMemberHash 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.HLocationCollection.TryGetVARCDocClassMemberNote 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.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCDoc.HLocationCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkCollection.InsertLinks Overload1ARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCDoc.HTOCARCDocClassHTOC = Hierarchical table of contents.
ARCDoc.DocLinkCollection.InsertLinks Overload2ARCDocClassMemberSee overload with 'contentLocation' as parameter for documentation.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCDoc.DocFragP.AssemblyARCDocEnumMemberName of the assembly in which this fragment resides.
ARCDoc.HTOC.CreateARCDocClassMemberStructures content hierarchically according to the criteria for each level.
ARCDoc.Orange.StorageARCDocClassMemberUses int-value of -__enum- minus 1 as index.
ARCDoc.DocFragP.NamespaceARCDocEnumMemberNamespace in which this fragment resides.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2ARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.SomeAppComponentARCDocClassDemonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.DocFragP.ParentNamespaceARCDocEnumMemberParent namespace of namespace in which this fragment resides.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1ARCDocClassMemberUse this method in any class where a table-of-contents type of view is desireable
ARCDoc.SomeAppComponent.MethodCARCDocClassMemberNote structured format in logging.
ARCDoc.DocFragP.TypeARCDocEnumMemberType of class or enum which this fragment describes (also relevant for class or enum member).
ARCDoc.HTOC.CreateInitialContentARCDocClassMemberHelper method for creation of a -FilterBranch-.
ARCDoc.SomeAppComponent.MethodDARCDocClassMemberSame as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.DocFragP.NameARCDocEnumMemberAs simple a name as practical usable. Often not unique within a greater context.
ARCDoc.HTOC.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.SomeAppComponent.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragP.IsInheritedARCDocEnumMemberRelevant for class members. TRUE if method is inherited from a base type.
ARCDoc.HTOC.TryGetVARCDocClassMemberNote 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.DocFragARCDocClassDocFrag = Document fragment.
ARCDoc.DocFragP.IsInheritedDocARCDocEnumMemberRelevant for class members (methods).
ARCDoc.HTOC.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFrag.Create Overload1ARCDocClassMemberCreates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocFragP.LinesARCDocEnumMemberNumber of lines of text in -Description- and -LongDescription- for this fragment.
ARCDoc.HTOC.HTOCContentThisLevelKeyARCDocClassMemberThe key used for storing the actual content at this level.
ARCDoc.DocFrag.Create Overload2ARCDocClassMemberCreates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.DocFragP.AttributeARCDocEnumMemberThe -BaseAttribute- or -PK- from which this -DocFrag- originates.
ARCDoc.PKDocAttributeARCDocClassDescribes documentation and presentation of a property.
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocFragTypeARCDocEnumType of documentation fragment, like -Assembly-, -Class- or -ClassMember-.
ARCDoc.PKDocAttribute.InitializeARCDocClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCDoc.DocFrag.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFragType.AssemblyARCDocEnumMember 
ARCDoc.PKDocAttribute.TryRemovePARCDocClassMemberShould probably never be used.
ARCDoc.DocFrag.TryGetVARCDocClassMemberNote 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.DocFragType.NamespaceARCDocEnumMember 
ARCDoc.PKDocAttribute.PriorityOrderARCDocClassMemberSee -PriorityOrder-.
ARCDoc.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragType.ClassARCDocEnumMemberDoes also include interfaces.
ARCDoc.PKDocAttribute.IsDefaultARCDocClassMemberDoes 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.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
ARCDoc.DocFragType.ClassMemberARCDocEnumMember 
ARCDoc.UtilDocARCDocClassUtility methods for -ARCDoc-.
ARCDoc.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.DocFragType.EnumARCDocEnumMember 
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTMLARCDocClassMemberReturns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy.
ARCDoc.DocFragCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFragType.EnumMemberARCDocEnumMember 
ARCDoc.UtilDoc.GenerateHTMLPageARCDocClassMemberWraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS.
ARCDoc.DocFragCollection.TryGetVARCDocClassMemberNote 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).
ARCQuery.CompoundKeyARCQueryClassA class able to expand the concept of entity keys.
ARCDoc.DocLinkPARCDocEnumDescribes class -DocLink-.
ARCDoc.Documentator.CreateHTOCNamespaceARCDocClassMemberCreates a table of contents structured by namespace
ARCQuery.CompoundKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCDoc.DocLinkP.LocationARCDocEnumMemberThe location that this link points to.
ARCDoc.Documentator.CreateHTOCInheritanceARCDocClassMemberCreates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCQuery.CompoundKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCDoc.DocLinkP.FilenameARCDocEnumMember 
ARCDoc.Documentator.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.CompoundKey.ParseARCQueryClassMemberNote that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails').
ARCDoc.DocLinkP.LinkWordHTMLARCDocEnumMemberActual link as it is expected to occur in text, like '-MyCustomerClass&lt;T&gt;-'.
ARCDoc.Documentator.TryGetVARCDocClassMemberNote 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).
ARCQuery.CompoundKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCDoc.DocLinkResolutionPARCDocEnumDescribes class -DocLinkResolution-
ARCDoc.Documentator.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.CompoundKey.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCDoc.DocLinkResolutionP.LinkWordARCDocEnumMember 
ARCDoc.Documentator.DocLinksARCDocClassMemberSet by -CreateAndInsert-.
ARCQuery.CompoundKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCDoc.DocLinkResolutionP.DocLinksARCDocEnumMemberThe possible links for -LinkWord-
ARCDoc.Documentator.DocLinkResolutionLocationARCDocClassMemberDefault position within the global storage context of doc link resolution pages.
ARCQuery.ConstantKey<T>ARCQueryClassRepresents a constant expression like "' '", "', '", "42".
ARCDoc.DocumentatorPARCDocEnumDescribes class -Documentator-.
ARCDoc.DummyEnumARCDocClassTODO: Document better what this is for (and change name)

Generated 2026-06-28 06:09:11.963 UTC