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

125 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.ARConcepts.Documentation	ARCCore	EnumMember	Thanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCCore.ARComponents.ARAAPI	ARCCore	EnumMember	The corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc.
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessages	ARCCore	EnumMember	The abstraction level in AgoRapide is very high.
ARCCore.ARConcepts	ARCCore	Enum	The overarching concepts upon which AgoRapide is built.
ARCCore.ARConcepts.ExposingApplicationState	ARCCore	EnumMember	The traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.
ARCCore.PSPrefix.dtr	ARCCore	EnumMember	Data, whole records.
ARCCore.PP.Created	ARCCore	EnumMember	Timestamp when property was created in database.
ARCCore.PSPrefix.RS	ARCCore	EnumMember	RS = Registration Stream (see -RegStream-).
ARCCore.PP.Cid	ARCCore	EnumMember	Creator id (entity which created this property).
ARCCore.PSPrefix.ES	ARCCore	EnumMember	ES = Event Stream (see -EventStream-).
ARCCore.PP.Value	ARCCore	EnumMember	The actual value.
ARCCore.PSPrefix.cmd	ARCCore	EnumMember	Command.
ARCCore.PP.Valid	ARCCore	EnumMember	Timestamp when property was last known to be (still) valid
ARCCore.PSPrefix.app	ARCCore	EnumMember	Application state, like app/
ARCCore.PP.Vid	ARCCore	EnumMember	Validator id, that is entity which set -Valid- for this property.
ARCCore.PSPrefix.doc	ARCCore	EnumMember	Documentation.
ARCCore.PP.Invalid	ARCCore	EnumMember	Timestamp when property was invalidated / 'deleted'.
ARCCore.PSPrefix.t	ARCCore	EnumMember	Translations.
ARCCore.PP.Iid	ARCCore	EnumMember	Invalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCCore.PKHTMLAttributeP	ARCCore	Enum	Describes class -PKRelAttribute-.
ARCCore.PP.ExceptionText	ARCCore	EnumMember	General property for logging of exceptions, usually set through -HandleException-.
ARCCore.PKHTMLAttributeP.Encoder	ARCCore	EnumMember	The class doing the HTML-encoding.
ARCCore.PConcurrentP	ARCCore	Enum	Describes class -PConcurrent-.
ARCCore.PKLogAttributeP	ARCCore	Enum	Describes class -PKLogAttribute.
ARCCore.PConcurrentP.Heartbeat	ARCCore	EnumMember
ARCCore.PKLogAttributeP.DoNotLogAtAll	ARCCore	EnumMember	Originates from -DoNotLogAtAll-.
ARCCore.ActualConnectionP	ARCCore	Enum	Describes class -ActualConnection-.
ARCCore.PKLogAttributeP.CountInterval	ARCCore	EnumMember	For a value of n, log only every n'th time the property is changed.
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.PKLogAttributeP.TimeInterval	ARCCore	EnumMember	Specifies a certain time interval for which the property's value shall be sent over the -PropertyStream-.
ARCCore.ActualConnectionP.ConnectionInstruction	ARCCore	EnumMember	Only relevant when we are an -Outgoing-.
ARCCore.PKRelAttributeP	ARCCore	Enum	Describes class -PKRelAttribute-.
ARCCore.ActualConnectionP.ConnectionDirection	ARCCore	EnumMember
ARCCore.PKRelAttributeP.ForeignEntity	ARCCore	EnumMember	The type of foreign entity that this property points to.
ARCCore.ActualConnectionP.CountReceiveMessage	ARCCore	EnumMember
ARCCore.PKRelAttributeP.OppositeTerm	ARCCore	EnumMember	Example: For 'Employee', the key 'SupervisorId' where the supervisor is another 'Employee', will have another meaning "as seen from" the Supervisor, namely "Subordinates" or similar.
ARCCore.ActualConnectionP.CountSendMessage	ARCCore	EnumMember
ARCCore.ConnectionInstructionP.Sharding	ARCCore	EnumMember
ARCCore.StreamProcessorP.TimestampResolution	ARCCore	EnumMember	The time interval between each timestamp update in the -PropertyStream-.
ARCCore.MultipleConnectionUsage	ARCCore	Enum	Enables fault-tolerance by describing use of multiple connections
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-.
ARCCore.MultipleConnectionUsage.Admin	ARCCore	EnumMember	Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally	ARCCore	EnumMember	Means 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.MultipleConnectionUsage.RoundRobin	ARCCore	EnumMember	This connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.StreamProcessorP.CacheDiskWrites	ARCCore	EnumMember	If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.MultipleConnectionUsage.Simultaneous	ARCCore	EnumMember	This connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.StreamProcessorP.CopyFileStructureFromCore	ARCCore	EnumMember	If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.StreamProcessorP	ARCCore	Enum	Describes class -StreamProcessor-.
ARCCore.StreamProcessorP.CountIncomingConnections	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.CountOutgoingConnections	ARCCore	EnumMember
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.CountOutsideLocalReceiver	ARCCore	EnumMember	Count of calls to -OutsideLocalReceiver-.
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.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin	ARCCore	EnumMember	Count of -PropertyStreamLine- not with -HasLocalOrigin-.
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.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.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.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.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.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-:
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCDoc.Demonstrator	ARCDoc	Class	Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.Demonstrator.DemonstratePropertyAccessApple	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Apple- class.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCDoc.Demonstrator.DemonstratePropertyAccessOrange	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Orange- class.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.Demonstrator.DemonstratePropertyAccessBanana	ARCDoc	ClassMember	Demonstrates use of -PropertyAccess- through the -Banana- class.
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Demonstrator.DemonstrateITypeDescriber	ARCDoc	ClassMember	Demonstrates use of -ITypeDescriber- for describing single-property values.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage	ARCDoc	ClassMember	Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.Demonstrator.DemonstratePropertyStream	ARCDoc	ClassMember	Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console.
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.Demonstrator.DemonstrateBareBonesClient	ARCDoc	ClassMember	Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Demonstrator.DemonstrateLogConsole	ARCDoc	ClassMember	Demonstrates a quite simple log console.
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.DemonstrateStreamProcessorAsClient	ARCDoc	ClassMember	Demonstrates use of -StreamProcessor- as a general client.
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.Orange	ARCDoc	Class	Inherits -PExact- for probably the best compromise between memory consumption and easy of development.
ARCDoc.DocFrag.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.DocFragCollection	ARCDoc	Class	Contains a collection of -DocFrag- objects.
ARCDoc.Orange.GetPVDirect	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.TryGetPVDirect	ARCDoc	ClassMember	High performance alternative to -TryGetP-, accessing -Storage- more direct.
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.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).
ARCDoc.Orange.Name	ARCDoc	ClassMember	See -Name- for more information.
ARCDoc.DocLinkResolutionCollection	ARCDoc	Class	Contains a collection of -DocLinkResolution- objects.
ARCDoc.DocLink.LinkWordHTMLWithHyphens	ARCDoc	ClassMember	-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
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.DocLink.LinkWordHTMLBeforeLt	ARCDoc	ClassMember	If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
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.DocLink.LinkWordHTMLBeforeLtWithHyphens	ARCDoc	ClassMember	-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLinkResolutionCollection.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.Documentator	ARCDoc	Class	General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.DocLinkCollection	ARCDoc	Class	Contains a collection of -DocLink- objects.
ARCDoc.Documentator.CreateAndInsert	ARCDoc	ClassMember	Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.DocLinkCollection.Create	ARCDoc	ClassMember	Notes all locations and their positions in the hierarchical directory structure.
ARCDoc.Documentator.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocLinkCollection.InsertLinks Overload1	ARCDoc	ClassMember	Does -LinkInsertionInDocumentation- on the given HTML content.
ARCDoc.Documentator.CreateHTOCStandard	ARCDoc	ClassMember	Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.DocLinkCollection.InsertLinks Overload2	ARCDoc	ClassMember	See overload with 'contentLocation' as parameter for documentation.
ARCCore.ARNodeType.ArmDB	ARCCore	EnumMember	A node with a 'client -Subscription-' towards -CoreDB- to a (usually) subset of the entire database (acting as a cache and filtering mechanism), or with a 'client -Subscription-' towards -CoreDB- to the whole database (acting as a cache mechanism only)
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.
ARCCore.ARConcepts.LinkInsertionInDocumentation	ARCCore	EnumMember	Documentation with links is much easier to read.
ARCDoc.Documentator.CreateHTOCNamespace	ARCDoc	ClassMember	Creates a table of contents structured by namespace
ARCCore.ARNodeType.Client	ARCCore	EnumMember	An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-.
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).
ARCCore.ARConcepts.TryPatternAndNull	ARCCore	EnumMember	AgoRapide uses non-nullable reference types as default throughout the system
ARCDoc.Documentator.CreateHTOCInheritance	ARCDoc	ClassMember	Creates a table of contents structured by inheritance (classes and interfaces only, not members).

Generated 2025-08-09 09:24:03.166 UTC