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

128 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.MultipleConnectionUsage.RoundRobin	ARCCore	EnumMember	This connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.StreamProcessorP.CopyFileStructureFromCore	ARCCore	EnumMember	If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.MultipleConnectionUsage.Simultaneous	ARCCore	EnumMember	This connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.StreamProcessorP.CountIncomingConnections	ARCCore	EnumMember
ARCCore.StreamProcessorP	ARCCore	Enum	Describes class -StreamProcessor-.
ARCCore.StreamProcessorP.CountOutgoingConnections	ARCCore	EnumMember
ARCCore.StreamProcessorP.LocalStorageFolder	ARCCore	EnumMember	The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCCore.StreamProcessorP.CountOutsideLocalReceiver	ARCCore	EnumMember	Count of calls to -OutsideLocalReceiver-.
ARCCore.StreamProcessorP.IndividualStorageFileSize	ARCCore	EnumMember	Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCCore.StreamProcessorP.CountReceiveLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCCore.StorageFileP	ARCCore	Enum	Describes class -StorageFile-.
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.StorageFileP.Filename	ARCCore	EnumMember
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.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.Name	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCCore.ConnectionDirection	ARCCore	Enum	The concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCDoc.Banana	ARCDoc	Class	Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCCore.ConnectionDirection.Incoming	ARCCore	EnumMember	ConnectionInstruction will not be set for these.
ARCDoc.Banana.Name	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.ConnectionDirection.Outgoing	ARCCore	EnumMember	There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCDoc.Banana.Colour	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCCore.DataTransferDirection	ARCCore	Enum	Direction for transfer of data.
ARCDoc.Demonstrator	ARCDoc	Class	Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
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.Demonstrator.DemonstratePropertyAccessApple	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Apple- class.
ARCCore.DataTransferDirection.Receive	ARCCore	EnumMember	Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Orange- class.
ARCCore.TPropertyKeyEnum	ARCCore	Enum	Placeholder for any enum type suitable as generic type parameter for -PExact-.
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Banana- class.
Assembly ARCDoc		Assembly	A library supporting documentation and demonstrating usage of AgoRapide.
ARCDoc.Demonstrator.DemonstrateITypeDescriber	ARCDoc	ClassMember	Demonstrates use of -ITypeDescriber- for describing single-property values.
ARCDoc.Apple	ARCDoc	Class	The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage	ARCDoc	ClassMember	Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCDoc.Apple.AddName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Demonstrator.DemonstratePropertyStream	ARCDoc	ClassMember	Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCDoc.Apple.GetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Demonstrator.DemonstrateBareBonesClient	ARCDoc	ClassMember	Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCDoc.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Demonstrator.DemonstrateLogConsole	ARCDoc	ClassMember	Demonstrates a quite simple log console.
ARCDoc.Apple.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
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).
ARCDoc.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCDoc.Apple.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Orange.SetPVDirect	ARCDoc	ClassMember	High performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCDoc.Orange.GetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.DocFragCollection	ARCDoc	Class	Contains a collection of -DocFrag- objects.
ARCDoc.Orange.TryGetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.DocFragCollection.Create	ARCDoc	ClassMember	Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.Orange.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
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.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCDoc.DocFragCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.DocLink	ARCDoc	Class	Describes to where a single HTML link points.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCDoc.DocLink.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
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.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCDoc.DocLink.Location	ARCDoc	ClassMember	Copy of -Location-.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocLink.Filename	ARCDoc	ClassMember	Copy of -LinkWordHTML-.
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.DocLink.LinkWordHTML	ARCDoc	ClassMember	Copy of -LinkWordHTML-.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocLink.LinkWordHTMLWithHyphens	ARCDoc	ClassMember	-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocFrag.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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.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.DocLink.LinkWordHTMLBeforeLtWithHyphens	ARCDoc	ClassMember	-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocFrag.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.AHrefEndPart	ARCDoc	ClassMember	'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCDoc.DocLinkCollection	ARCDoc	Class	Contains a collection of -DocLink- objects.
ARCDoc.Extensions.ToHTMLSimpleSingleRecursive	ARCDoc	ClassMember	Calls -ToHTMLSimpleSingle- recursively.
ARCDoc.DocLinkCollection.Create	ARCDoc	ClassMember	Notes all locations and their positions in the hierarchical directory structure.
ARCDoc.Extensions.ToHTMLSimpleSingle	ARCDoc	ClassMember	Creates a simple HTML representation of the given parameter.
ARCDoc.DocLinkCollection.InsertLinks Overload1	ARCDoc	ClassMember	Does -LinkInsertionInDocumentation- on the given HTML content.
ARCDoc.Extensions.ToHTMLSimpleSingleInternal	ARCDoc	ClassMember	Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
ARCDoc.DocLinkCollection.InsertLinks Overload2	ARCDoc	ClassMember	See overload with 'contentLocation' as parameter for documentation.
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.DocLinkCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Extensions.DescribeValue	ARCDoc	ClassMember	Describes the value contained withing an -IKIP- (-P-).
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.Extensions.ValueToHTMLSimpleWithTooltip	ARCDoc	ClassMember	Creates a simple HTML representation of the Value with description as a 'tooltip'.
ARCDoc.DocLinkCollection.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.DocLinkResolution	ARCDoc	Class	Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCDoc.Extensions.GetHelptextHTML	ARCDoc	ClassMember	Returns content of -Description- and -LongDescription-.
ARCDoc.DocLinkResolution.ToHTMLSimpleSingle	ARCDoc	ClassMember	Gives a friendly description about possible targets for LinkWord-.
ARCDoc.HLocation	ARCDoc	Class	Simple class describing the location of a single -IP- instance within some hierarhical context.
ARCDoc.DocLinkResolution.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HLocation.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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).
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.DocLinkResolution.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocation.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolutionCollection	ARCDoc	Class	Contains a collection of -DocLinkResolution- objects.
ARCDoc.HLocation.Content	ARCDoc	ClassMember	The Content object is not stored within the standard -IP--mechanism.
ARCDoc.DocLinkResolutionCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HLocationCollection	ARCDoc	Class	Contains a collection of -HLocation- objects.
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).
ARCDoc.HLocationCollection.Create	ARCDoc	ClassMember	Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.DocLinkResolutionCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk	ARCDoc	ClassMember	Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.Documentator	ARCDoc	Class	General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.HLocationCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Documentator.CreateAndInsert	ARCDoc	ClassMember	Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
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.Documentator.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.HLocationCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator.CreateHTOCStandard	ARCDoc	ClassMember	Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.HTOC	ARCDoc	Class	HTOC = Hierarchical table of contents.
ARCDoc.Documentator.CreateHTOCNamespace	ARCDoc	ClassMember	Creates a table of contents structured by namespace
ARCDoc.HTOC.Create	ARCDoc	ClassMember	Structures content hierarchically according to the criteria for each level.
ARCDoc.Documentator.CreateHTOCInheritance	ARCDoc	ClassMember	Creates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Documentator.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1	ARCDoc	ClassMember	Use this method in any class where a table-of-contents type of view is desireable
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).

Generated 2025-07-11 20:40:37.962 UTC