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

124 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCDoc.Apple	ARCDoc	Class	The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-.
ARCCore.StreamProcessorP.LocalStorageFolder	ARCCore	EnumMember	The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCDoc.Apple.AddName	ARCDoc	ClassMember	Convenience method, not obligatory.
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-.
ARCDoc.Apple.GetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCCore.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCDoc.Apple.TryGetName	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
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.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCDoc.Apple.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.StreamProcessorP.IncomingConnectionsPortNo	ARCCore	EnumMember	If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCDoc.Apple.Name	ARCDoc	ClassMember	Convenience method, not obligatory.
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCDoc.Banana	ARCDoc	Class	Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency.
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
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.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
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.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCDoc.Demonstrator	ARCDoc	Class	Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCCore.StreamProcessorP.TimestampResolution	ARCCore	EnumMember	The time interval between each timestamp update in the -PropertyStream-.
ARCDoc.Demonstrator.DemonstratePropertyAccessApple	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Apple- class.
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-.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Orange- class.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally	ARCCore	EnumMember	Means 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Banana- class.
ARCCore.StreamProcessorP.CacheDiskWrites	ARCCore	EnumMember	If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCDoc.Demonstrator.DemonstrateITypeDescriber	ARCDoc	ClassMember	Demonstrates use of -ITypeDescriber- for describing single-property values.
ARCQuery.QueryExpressionAggregate	ARCQuery	Class	Aggregates over the given key.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage	ARCDoc	ClassMember	Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCQuery.QueryExpressionAggregate.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCDoc.Demonstrator.DemonstratePropertyStream	ARCDoc	ClassMember	Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCQuery.QueryExpressionAggregate.IsSuitableAggregator	ARCQuery	ClassMember	Returns true if
ARCDoc.Demonstrator.DemonstrateBareBonesClient	ARCDoc	ClassMember	Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCQuery.QueryExpressionAggregate.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCDoc.Demonstrator.DemonstrateLogConsole	ARCDoc	ClassMember	Demonstrates a quite simple log console.
ARCQuery.QueryExpressionAggregate.SyntaxHelp	ARCQuery	ClassMember	1) 'AGGREGATE {rowKey}' like "AGGREGATE Product"
ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
ARCQuery.QueryExpressionAggregate.AggregationType	ARCQuery	ClassMember	Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCDoc.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCQuery.QueryExpressionAggregate.AggregationKey	ARCQuery	ClassMember	This is often null (with -AggregationType- correspondingly set to Count-).
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
ARCQuery.QueryExpressionAll	ARCQuery	Class	Represents all entities for a given collection.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCQuery.QueryExpressionAll.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCQuery.QueryExpressionAll.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCQuery.QueryExpressionAll.SyntaxHelp	ARCQuery	ClassMember	'ALL' (literally).
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCQuery.QueryExpressionCache	ARCQuery	Class	Describes if cache is to be used or not.
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionCache.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCQuery.QueryExpressionCache.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCQuery.QueryExpressionCache.SyntaxHelp	ARCQuery	ClassMember	CACHE {ON\|OFF}
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCQuery.QueryExpressionHint	ARCQuery	Class	Describes if hints are to be generated (as query progresses) for potential new queries.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryExpressionShuffle	ARCQuery	Class	Shuffles collection in random order.
ARCDoc.DocLinkCollection	ARCDoc	Class	Contains a collection of -DocLink- objects.
ARCQuery.QueryExpressionShuffle.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCDoc.DocLinkCollection.Create	ARCDoc	ClassMember	Notes all locations and their positions in the hierarchical directory structure.
ARCQuery.QueryExpressionShuffle.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCDoc.DocLinkCollection.InsertLinks	ARCDoc	ClassMember	Does -LinkInsertionInDocumentation- on the given HTML content.
ARCQuery.QueryExpressionShuffle.SyntaxHelp	ARCQuery	ClassMember	SHUFFLE
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).
ARCQuery.QueryExpressionSkip	ARCQuery	Class	Skips the specified number of elements from the current query result.
ARCDoc.DocLinkCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionSkip.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCDoc.DocLinkResolution	ARCDoc	Class	Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCQuery.QueryExpressionSkip.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCDoc.DocLinkResolution.ToHTMLSimpleSingle	ARCDoc	ClassMember	Gives a friendly description about possible targets for LinkWord-.
ARCQuery.QueryExpressionSkip.SyntaxHelp	ARCQuery	ClassMember	SKIP {Count} like 'SKIP 42'
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.DocLinkResolutionCollection	ARCDoc	Class	Contains a collection of -DocLinkResolution- 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.DocLinkResolutionCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator	ARCDoc	Class	General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.Documentator.CreateAndInsert	ARCDoc	ClassMember	Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.Documentator.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Documentator.CreateHTOCStandard	ARCDoc	ClassMember	Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip	ARCDoc	ClassMember	Creates a simple HTML representation of the Key with description as a 'tooltip'.
ARCDoc.HLocation	ARCDoc	Class	Simple class describing the location of a single -IP- instance within some hierarhical context.
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.HLocation.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocation.Content	ARCDoc	ClassMember	The Content object is not stored within the standard -IP--mechanism.
ARCDoc.HLocationCollection	ARCDoc	Class	Contains a collection of -HLocation- objects.
ARCDoc.HLocationCollection.Create	ARCDoc	ClassMember	Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk	ARCDoc	ClassMember	Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
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.HLocationCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOC	ARCDoc	Class	HTOC = Hierarchical table of contents.
ARCDoc.HTOC.Create	ARCDoc	ClassMember	Structures content hierarchically according to the criteria for each level.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1	ARCDoc	ClassMember	Use this method in any class where a table-of-contents type of view is desireable
ARCDoc.HTOC.CreateInitialContent	ARCDoc	ClassMember	Helper method for creation of a -FilterBranch-.
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.HTOC.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOC.HTOCContentThisLevelKey	ARCDoc	ClassMember	The key used for storing the actual content at this level.
ARCDoc.PKDocAttribute	ARCDoc	Class	Describes documentation and presentation of a property.
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.PKDocAttribute.TryRemoveP	ARCDoc	ClassMember	Should probably never be used.
ARCDoc.PKDocAttribute.PriorityOrder	ARCDoc	ClassMember	See -PriorityOrder-.
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.UtilDoc	ARCDoc	Class	Utility methods for -ARCDoc-.
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.UtilDoc.GenerateHTMLPage	ARCDoc	ClassMember	Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS.
ARCDoc.HTOC+ParentChain	ARCDoc	Class	Used by -FilterNode- in order to keep track of node's parents.
ARCDoc.AppleP	ARCDoc	Enum	Describes class -Apple-.
ARCDoc.AppleP.Name	ARCDoc	EnumMember	The name of the apple
ARCDoc.AppleP.Colour	ARCDoc	EnumMember
ARCDoc.BananaP	ARCDoc	Enum	Describes class -Banana-.
ARCDoc.BananaP.Name	ARCDoc	EnumMember	The name of the banana
ARCDoc.BananaP.Colour	ARCDoc	EnumMember
ARCDoc.OrangeP	ARCDoc	Enum	Describes class -Orange-.
ARCDoc.OrangeP.Name	ARCDoc	EnumMember	The name of the orange
ARCDoc.OrangeP.Colour	ARCDoc	EnumMember
ARCDoc.SomeAppComponentP	ARCDoc	Enum	Describes class -SomeAppComponent-.
ARCDoc.SomeAppComponentP.SomeCountValue	ARCDoc	EnumMember
ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged	ARCDoc	EnumMember

Generated 2025-11-05 07:12:50.917 UTC