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

128 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.TPropertyKeyEnum	ARCCore	Enum	Placeholder for any enum type suitable as generic type parameter for -PExact-.
Assembly ARCDoc		Assembly	A library supporting documentation and demonstrating usage of AgoRapide.
ARCDoc.Apple	ARCDoc	Class	The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCDoc.Apple.AddName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Apple.GetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Demonstrator.DemonstrateLogConsole	ARCDoc	ClassMember	Demonstrates a quite simple log console.
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
ARCDoc.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
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.Orange.TryGetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCDoc.Orange.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
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.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.DocLinkCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolution	ARCDoc	Class	Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCDoc.DocLinkResolution.ToHTMLSimpleSingle	ARCDoc	ClassMember	Gives a friendly description about possible targets for LinkWord-.
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.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.DocLinkResolution.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DummyEnum.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.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.DummyEnum.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Extensions	ARCDoc	Class	Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML.
ARCDoc.Extensions.ToHTMLSimpleSingleRecursive	ARCDoc	ClassMember	Calls -ToHTMLSimpleSingle- recursively.
ARCDoc.Extensions.ToHTMLSimpleSingle	ARCDoc	ClassMember	Creates a simple HTML representation of the given parameter.
ARCDoc.Extensions.ToHTMLSimpleSingleInternal	ARCDoc	ClassMember	Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
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.
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.CountReceiveLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.PConcurrentP	ARCCore	Enum	Describes class -PConcurrent-.
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.PConcurrentP.Heartbeat	ARCCore	EnumMember
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	ARCCore	Enum	Describes class -StorageFile-.
ARCCore.ActualConnectionP	ARCCore	Enum	Describes class -ActualConnection-.
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.Filename	ARCCore	EnumMember
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.
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
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
ARCCore.ActualConnectionP.ConnectionInstruction	ARCCore	EnumMember	Only relevant when we are an -Outgoing-.
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
ARCCore.ConnectionDirection	ARCCore	Enum	The concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.ActualConnectionP.ConnectionDirection	ARCCore	EnumMember
ARCCore.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.ConnectionDirection.Incoming	ARCCore	EnumMember	ConnectionInstruction will not be set for these.
ARCCore.ActualConnectionP.CountReceiveMessage	ARCCore	EnumMember
ARCCore.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.ConnectionDirection.Outgoing	ARCCore	EnumMember	There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCCore.ActualConnectionP.CountSendMessage	ARCCore	EnumMember
ARCDoc.DocFragCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCDoc.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.DocLink	ARCDoc	Class	Describes to where a single HTML link points.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
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.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.MethodC	ARCDoc	ClassMember	Note structured format in logging.
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.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.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.Apple.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.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Apple.Name	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.DocLink.Location	ARCDoc	ClassMember	Copy of -Location-.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCDoc.Banana	ARCDoc	Class	Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCDoc.DocLink.Filename	ARCDoc	ClassMember	Copy of -LinkWordHTML-.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
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)
ARCDoc.DocLink.LinkWordHTML	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.Banana.Colour	ARCDoc	ClassMember	Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc)
ARCDoc.DocLink.LinkWordHTMLWithHyphens	ARCDoc	ClassMember	-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Demonstrator	ARCDoc	Class	Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
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.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.DemonstratePropertyAccessApple	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Apple- class.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens	ARCDoc	ClassMember	-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
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.Demonstrator.DemonstratePropertyAccessOrange	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Orange- class.
ARCDoc.DocLink.AHrefEndPart	ARCDoc	ClassMember	'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCDoc.DocFrag.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Banana- class.
ARCDoc.DocLinkCollection	ARCDoc	Class	Contains a collection of -DocLink- objects.
ARCDoc.DocFragCollection	ARCDoc	Class	Contains a collection of -DocFrag- objects.
ARCDoc.Demonstrator.DemonstrateITypeDescriber	ARCDoc	ClassMember	Demonstrates use of -ITypeDescriber- for describing single-property values.
ARCDoc.DocLinkCollection.Create	ARCDoc	ClassMember	Notes all locations and their positions in the hierarchical directory structure.
ARCDoc.DocFragCollection.Create	ARCDoc	ClassMember	Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage	ARCDoc	ClassMember	Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCDoc.DocLinkCollection.InsertLinks Overload1	ARCDoc	ClassMember	Does -LinkInsertionInDocumentation- on the given HTML content.
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.Demonstrator.DemonstratePropertyStream	ARCDoc	ClassMember	Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCDoc.DocLinkCollection.InsertLinks Overload2	ARCDoc	ClassMember	See overload with 'contentLocation' as parameter for documentation.
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.Demonstrator.DemonstrateBareBonesClient	ARCDoc	ClassMember	Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCDoc.HLocation.Content	ARCDoc	ClassMember	The Content object is not stored within the standard -IP--mechanism.
ARCDoc.PKDocAttribute	ARCDoc	Class	Describes documentation and presentation of a property.
ARCDoc.DocLinkResolutionCollection	ARCDoc	Class	Contains a collection of -DocLinkResolution- objects.
ARCDoc.HLocationCollection	ARCDoc	Class	Contains a collection of -HLocation- objects.
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.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.Create	ARCDoc	ClassMember	Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.PKDocAttribute.TryRemoveP	ARCDoc	ClassMember	Should probably never be used.
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.WriteAllContentHTMLToDisk	ARCDoc	ClassMember	Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.PKDocAttribute.PriorityOrder	ARCDoc	ClassMember	See -PriorityOrder-.
ARCDoc.DocLinkResolutionCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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.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.Documentator	ARCDoc	Class	General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
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.UtilDoc	ARCDoc	Class	Utility methods for -ARCDoc-.
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.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTML	ARCDoc	ClassMember	Returns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy.
ARCDoc.Documentator.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.HTOC	ARCDoc	Class	HTOC = Hierarchical table of contents.
ARCDoc.UtilDoc.GenerateHTMLPage	ARCDoc	ClassMember	Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS.
ARCDoc.Documentator.CreateHTOCStandard	ARCDoc	ClassMember	Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.HTOC.Create	ARCDoc	ClassMember	Structures content hierarchically according to the criteria for each level.
ARCDoc.UtilDoc.GlobalHeaderHTML	ARCDoc	ClassMember	Global header to be inserted at the top of every HTML page created by -GenerateHTMLPage-.
ARCDoc.Documentator.CreateHTOCNamespace	ARCDoc	ClassMember	Creates a table of contents structured by namespace

Generated 2025-07-11 19:31:50.794 UTC