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

124 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.ConnectionDirection	ARCCore	Enum	The concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.ClassMemberAttribute.Initialize	ARCCore	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.
ARCCore.DataTransferDirection.Receive	ARCCore	EnumMember	Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCCore.DataTransferDirection	ARCCore	Enum	Direction for transfer of data.
ARCCore.ClassMemberAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.TPropertyKeyEnum	ARCCore	Enum	Placeholder for any enum type suitable as generic type parameter for -PExact-.
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-.
ARCCore.ClassMemberAttribute.IsDefault	ARCCore	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.Apple.AddName	ARCDoc	ClassMember	Convenience method, not obligatory.
Assembly ARCDoc		Assembly	A library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.EnumAttribute	ARCCore	Class	Describes an enum.
ARCDoc.Apple.GetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Apple	ARCDoc	Class	The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCCore.EnumAttribute.GetAttribute	ARCCore	ClassMember	Throws exception if tagged as -PropertyKeyEnum- and name of type does not end with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance).
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.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCCore.EnumAttribute.Initialize	ARCCore	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.Apple.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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.
ARCCore.EnumAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the enum which this instance describes.
ARCDoc.Apple.Name	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Orange- class.
ARCCore.EnumAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCDoc.Banana	ARCDoc	Class	Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Banana- class.
ARCCore.EnumAttribute.IsDefault	ARCCore	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.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.Demonstrator.DemonstrateITypeDescriber	ARCDoc	ClassMember	Demonstrates use of -ITypeDescriber- for describing single-property values.
ARCCore.EnumMemberAttribute	ARCCore	Class	Describes an enum's value.
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.Demonstrator.DemonstratePRichHierarchicalStorage	ARCDoc	ClassMember	Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCCore.EnumMemberAttribute.GetAttribute	ARCCore	ClassMember	Note that illegal to call for -PropertyKeyEnum-.
ARCDoc.Demonstrator	ARCDoc	Class	Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCDoc.Demonstrator.DemonstratePropertyStream	ARCDoc	ClassMember	Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCCore.EnumMemberAttribute.Initialize	ARCCore	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.Demonstrator.DemonstratePropertyAccessApple	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Apple- class.
ARCDoc.Demonstrator.DemonstrateBareBonesClient	ARCDoc	ClassMember	Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCCore.EnumMemberAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCDoc.Demonstrator.DemonstrateLogConsole	ARCDoc	ClassMember	Demonstrates a quite simple log console.
ARCDoc.Orange.GetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.EnumMemberAttribute.IsDefault	ARCCore	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.Demonstrator.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
ARCDoc.Orange.TryGetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
ARCCore.IPAttribute	ARCCore	Class	Describes -IP- classes (describes at class-level)
ARCDoc.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCDoc.Orange.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.CardinalityExtensions	ARCCore	Class
ARCDoc.Orange.SetPVDirect	ARCDoc	ClassMember	High performance alternative to -TrySetP-, accessing -Storage- more direct.
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
ARCCore.CardinalityExtensions.IsMultiple	ARCCore	ClassMember	Returns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.Extensions	ARCCore	Class	Contains a few general nice to have extensions methods.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCCore.Extensions.ToStringShort	ARCCore	ClassMember	Returns a shorter representation than -ToStringDB-.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCCore.Extensions.ToStringVeryShort	ARCCore	ClassMember	Returns same as -ToStringShort- but without any generics information at all.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCCore.Extensions.ToStringDB	ARCCore	ClassMember	Gives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocFragCollection	ARCDoc	Class	Contains a collection of -DocFrag- objects.
ARCCore.Extensions.ForEach	ARCCore	ClassMember	Useful when we want to write collection.ForEach( ... ) instead of
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.DocFragCollection.Create	ARCDoc	ClassMember	Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCCore.Extensions.Use	ARCCore	ClassMember	Convenience method that shortens down code in cases where an instance of an object must be created first in order to use that same variable multiple times
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.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.
ARCCore.Extensions.AddValue	ARCCore	ClassMember	Gives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCDoc.DocFrag.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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).
ARCCore.Extensions.KeysAsString	ARCCore	ClassMember	Gives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCDoc.DocFragCollection.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.
ARCCore.Extensions.GetValue	ARCCore	ClassMember	Gives better error messages when reading value from directory if key does not exist
ARCDoc.DocLink	ARCDoc	Class	Describes to where a single HTML link points.
ARCDoc.DocLink.Location	ARCDoc	ClassMember	Copy of -Location-.
ARCCore.Extensions.Single	ARCCore	ClassMember	Same as inbuilt LINQ's Single except that gives a more friendly exception message
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.DocLink.Filename	ARCDoc	ClassMember	Copy of -LinkWordHTML-.
ARCCore.Extensions.SingleOrDefault	ARCCore	ClassMember	Same as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
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.DocLink.LinkWordHTML	ARCDoc	ClassMember	Copy of -LinkWordHTML-.
ARCCore.Extensions.Result	ARCCore	ClassMember	Returns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCDoc.DocLink.LinkWordHTMLWithHyphens	ARCDoc	ClassMember	-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLinkCollection	ARCDoc	Class	Contains a collection of -DocLink- objects.
ARCCore.Extensions.ToStringDateAndTime	ARCCore	ClassMember	Uses format 'yyyy-MM-dd HH:mm:ss.fff'.
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.DocLinkCollection.Create	ARCDoc	ClassMember	Notes all locations and their positions in the hierarchical directory structure.
ARCCore.Extensions.ToStringWithMS	ARCCore	ClassMember	Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens	ARCDoc	ClassMember	-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLinkCollection.InsertLinks Overload1	ARCDoc	ClassMember	Does -LinkInsertionInDocumentation- on the given HTML content.
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCDoc.DocLink.AHrefEndPart	ARCDoc	ClassMember	'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCDoc.DocLinkCollection.InsertLinks Overload2	ARCDoc	ClassMember	See overload with 'contentLocation' as parameter for documentation.
ARCCore.IKIP.AssertTypeIntegrity	ARCCore	ClassMember	See -TryAssertTypeIntegrity- for documentation.
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.DocLinkResolution.ToHTMLSimpleSingle	ARCDoc	ClassMember	Gives a friendly description about possible targets for LinkWord-.
ARCCore.IKIP.TryAssertTypeIntegrity	ARCCore	ClassMember	Asserts that value is of correct type as specified by the key.
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.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.
ARCCore.IK	ARCCore	Class	IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCDoc.DocLinkCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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.IKCoded	ARCCore	Class	Understands coded and unencoded variants of -IK-.
ARCDoc.DocLinkResolution	ARCDoc	Class	Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCDoc.DocLinkResolution.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.IKCoded.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCDoc.DocLinkResolutionCollection	ARCDoc	Class	Contains a collection of -DocLinkResolution- objects.
ARCDoc.Documentator	ARCDoc	Class	General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCCore.IKCoded.TryCheckValidEncodedValue	ARCCore	ClassMember	Checks if encoded value is valid.
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.Documentator.CreateAndInsert	ARCDoc	ClassMember	Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCCore.IKCoded.FromCacheEncoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
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.Documentator.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCCore.IKCoded.FromCacheUnencoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCDoc.DocLinkResolutionCollection.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'.
ARCCore.IKCoded.FromEncoded	ARCCore	ClassMember	Note how uses instance cache if already exists there.
ARCDoc.Documentator.CreateHTOCNamespace	ARCDoc	ClassMember	Creates a table of contents structured by namespace
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.

Generated 2025-06-22 22:38:32.445 UTC