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

179 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCAPI.BaseController.GetTimestampIsOldWarningHTML	ARCAPI	ClassMember	If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCAPI.BaseController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.EditController	ARCAPI	Class	Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCAPI.EditController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.EditController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.GQController	ARCAPI	Class	Offers GraphQL queries.
ARCAPI.GQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.GQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.RQController	ARCAPI	Class	RQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCAPI.RQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.RQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.DataStorage	ARCAPI	Class	The all-in-memory global application data storage.
ARCAPI.DataStorage.Create	ARCAPI	ClassMember	Creates a -DataStorage- instance with default parameters.
ARCAPI.DataStorage..ctor	ARCAPI	ClassMember	This method will:
ARCAPI.DataStorage.Storage	ARCAPI	ClassMember	The actual storage.
ARCAPI.DataStorage.ControllerStorage	ARCAPI	ClassMember	Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCAPI.DataStorage.DocLinks	ARCAPI	ClassMember	Note that may be null.
ARCAPI.DataStorage.Lock	ARCAPI	ClassMember	Locking object for thread-safe access from simultaneous API requests.
ARCAPI.DataStorage.ExternalReceiver	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.DataStorage.DoNotStoreInternally	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.BaseControllerP	ARCAPI	Enum	Describes class -BaseController-.
ARCAPI.BaseControllerP.CountRequest	ARCAPI	EnumMember	Number of calls to -APIMethod- since application initialization
ARCAPI.BaseControllerP.CountException	ARCAPI	EnumMember	Number of exceptions at call to -APIMethod- since application initialization
ARCAPI.BaseControllerP.LogLevel	ARCAPI	EnumMember
ARCAPI.ResponseFormat	ARCAPI	Enum	The response format, HTML or JSON, for an API request.
ARCAPI.ResponseFormat.JSON	ARCAPI	EnumMember
ARCAPI.ResponseFormat.HTML	ARCAPI	EnumMember
Assembly AgoBrowse		Assembly
AgoBrowse.Program	AgoBrowse	Class
AgoBrowse.Program.InitStreamProcessor	AgoBrowse	ClassMember	Initializes stream processor.
AgoBrowse.Root	AgoBrowse	Class	Contains the user friendly welcome text (front page) for the application.
AgoBrowse.Root.ToHTMLSimpleSingle	AgoBrowse	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
AgoBrowse.Root.TryGetP	AgoBrowse	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
AgoBrowse.Root.TryGetV	AgoBrowse	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).
AgoBrowse.Root.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.CompileController	AgoBrowse	Class	Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
AgoBrowse.Controllers.CompileController.APIMethod	AgoBrowse	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.Compile	AgoBrowse	ClassMember	Compiles a hierarchical 'picture book' from the given parameter.
AgoBrowse.Controllers.CompileController.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.ControllerFacade	AgoBrowse	Class	Facade for entry into the desired -RQController-.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2	AgoBrowse	ClassMember	Catches all HTTP GET requests to this API.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1	AgoBrowse	ClassMember	Catches all HTTP POST requests to this API.
Namespace ARCCore		Namespace	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
Namespace ARCDoc		Namespace	A library supporting documentation and demonstrating usage of AgoRapide.
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
Namespace AgoBrowse		Namespace
Namespace AgoBrowse.Controllers		Namespace
ARCQuery.QueryExpressionAggregate.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionAggregate.SyntaxHelp	ARCQuery	ClassMember	1) 'AGGREGATE {rowKey}' like "AGGREGATE Product"
ARCQuery.QueryExpressionAggregate.AggregationType	ARCQuery	ClassMember	Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCQuery.QueryExpressionAggregate.AggregationKey	ARCQuery	ClassMember	This is often null (with -AggregationType- correspondingly set to Count-).
ARCQuery.QueryExpressionAll	ARCQuery	Class	Represents all entities for a given collection.
ARCQuery.QueryExpressionAll.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionAll.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionAll.SyntaxHelp	ARCQuery	ClassMember	'ALL' (literally).
ARCQuery.QueryExpressionCache	ARCQuery	Class	Describes if cache is to be used or not.
ARCQuery.QueryExpressionCache.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionCache.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionCache.SyntaxHelp	ARCQuery	ClassMember	CACHE {ON\|OFF}
ARCQuery.QueryExpressionComment	ARCQuery	Class	Allows insertion of SQL style comments (beginning with double hyphens / minus signs, '--') into queries.
ARCQuery.QueryExpressionComment.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionComment.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionComment.SyntaxHelp	ARCQuery	ClassMember	COMMENT {comment text}
ARCQuery.QueryExpressionDataStorage	ARCQuery	Class	Experimental as of Mar 2022: Resets value for -DataStorage-
ARCQuery.QueryExpressionDataStorage.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionDataStorage.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionDataStorage.SyntaxHelp	ARCQuery	ClassMember	DATASTORAGE {new hierarchical level} [link adjustment]
ARCQuery.QueryExpressionDataStorage.LinkAdjustment	ARCQuery	ClassMember	See -LinkAdjustment- for documentation.
ARCQuery.QueryExpressionDataStorage.GlobalDataStorage	ARCQuery	ClassMember	TODO: Find some better initialization here.
ARCQuery.QueryExpressionHint	ARCQuery	Class	Describes if hints are to be generated (as query progresses) for potential new queries.
ARCQuery.QueryExpressionHint.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionSelfCreate.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionSelfCreate.SyntaxHelp	ARCQuery	ClassMember	SELFCREATE {Type supporting ISelfCreateCollection}'
ARCQuery.QueryExpressionShuffle	ARCQuery	Class	Shuffles collection in random order.
ARCQuery.QueryExpressionShuffle.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionShuffle.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionShuffle.SyntaxHelp	ARCQuery	ClassMember	SHUFFLE
ARCQuery.QueryExpressionSkip	ARCQuery	Class	Skips the specified number of elements from the current query result.
ARCQuery.QueryExpressionSkip.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionSkip.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionSkip.SyntaxHelp	ARCQuery	ClassMember	SKIP {Count} like 'SKIP 42'
ARCQuery.QueryExpressionStrict	ARCQuery	Class	Describes -Strictness- ON / OFF when executing query.
ARCQuery.QueryExpressionStrict.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionStrict.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionStrict.SyntaxHelp	ARCQuery	ClassMember	STRICT {strictnessLevel}
ARCQuery.QueryExpressionTake	ARCQuery	Class	Takes a specific number of elements from the current query result.
ARCQuery.QueryExpressionTake.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionTake.SyntaxHelp	ARCQuery	ClassMember	TAKE {Count}
ARCQuery.QueryExpressionThenBy	ARCQuery	Class	Allows sorting by multiple columns.
ARCQuery.QueryExpressionThenBy.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionThenBy.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionThenBy.SyntaxHelp	ARCQuery	ClassMember	THEN BY {key} [DESC] / [ASC]
ARCQuery.QueryExpressionTitle	ARCQuery	Class	The title to be used in the final presentation of the query result.
ARCQuery.QueryExpressionTitle.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionTitle.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionTitle.SyntaxHelp	ARCQuery	ClassMember	TITLE {title}
ARCQuery.QueryExpressionWhere	ARCQuery	Class	Executes a 'WHERE {key} {operator} {value}' against the given collection.
ARCQuery.QueryExpressionWhere.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionWhere.IsMatch	ARCQuery	ClassMember	Returns TRUE if property matches criteria.
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionWhere.SyntaxHelp	ARCQuery	ClassMember	WHERE {key} {operator} {value}
ARCQuery.QueryExpressionWhere.Value	ARCQuery	ClassMember	The Value should ideally be as strongly typed as possible. Note that it may be of type -ValueEnum- relevant for queries like WHERE Name = NULL.
ARCCore.BaseAttribute.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.IKLong.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKString.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.ITypeDescriber	ARCCore	Class	Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
ARCCore.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
ARCCore.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
ARCDoc.DocLink.LinkWordHTML	ARCDoc	ClassMember	Copy of -LinkWordHTML-.
ARCDoc.DocLink.LinkWordHTMLWithHyphens	ARCDoc	ClassMember	-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
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.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.Documentator.CreateHTOCNamespace	ARCDoc	ClassMember	Creates a table of contents structured by namespace
ARCDoc.Documentator.CreateHTOCInheritance	ARCDoc	ClassMember	Creates a table of contents structured by inheritance (classes and interfaces only, not members).
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.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).
ARCDoc.HLocation	ARCDoc	Class	Simple class describing the location of a single -IP- instance within some hierarhical context.
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.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.UtilDoc.GlobalHeaderHTML	ARCDoc	ClassMember	Global header to be inserted at the top of every HTML page created by -GenerateHTMLPage-.
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.DocFragP.Name	ARCDoc	EnumMember	As simple a name as practical usable. Often not unique within a greater context.
ARCDoc.DocFragP.IsInherited	ARCDoc	EnumMember	Relevant for class members. TRUE if method is inherited from a base type.
ARCDoc.DocFragP.IsInheritedDoc	ARCDoc	EnumMember	Relevant for class members (methods).
ARCDoc.DocFragP.Lines	ARCDoc	EnumMember	Number of lines of text in -Description- and -LongDescription- for this fragment.
ARCDoc.DummyEnumP	ARCDoc	Enum	TODO: Document better what this is for (and change name)
ARCDoc.DummyEnumP._MemberInherited	ARCDoc	EnumMember	Contains not only members which are inherited in the object-oriented sense, but also overrides for which the only documentation was found in base class
ARCDoc.HLocationP	ARCDoc	Enum	Describes class -HLocation-.
ARCDoc.HLocationP.Location	ARCDoc	EnumMember	Folder names / hierarchical levels.
ARCDoc.HLocationP.Filename	ARCDoc	EnumMember	Either the last hierarhical key for the content's location, or Index.html if no location.
ARCDoc.HLocationP.ContentType	ARCDoc	EnumMember	The type of the content object. The actual content object is stored as -Content-.
ARCDoc.PKDocAttributeP	ARCDoc	Enum	Describes class -PKDocAttribute-.
ARCDoc.PKDocAttributeP.PriorityOrder	ARCDoc	EnumMember	Used by -DescribeValue-.
ARCQuery.CompoundKey	ARCQuery	Class	A class able to expand the concept of entity keys.
ARCQuery.CompoundKey.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.CompoundKey.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.CompoundKey.Parse	ARCQuery	ClassMember	Note that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails').
ARCQuery.EntityMethodKey.Method	ARCQuery	ClassMember	The actuall TryGet method implemented in the relevant entity class.
ARCQuery.EntityMethodKey.MethodNameAsIK	ARCQuery	ClassMember	Name of TryGet method but without 'TryGet' in name
ARCQuery.EntityMethodKey.ReturnType	ARCQuery	ClassMember	The type of the 'retval' out-parameter of the method.
ARCQuery.EntityMethodKey.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.EntityMethodKey.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.ForeignKey	ARCQuery	Class	Can find related values, through compound field names.
ARCQuery.ForeignKey.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.ForeignKey.ToString	ARCQuery	ClassMember	The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.ForeignKey.AllForeignKeysForEntityType	ARCQuery	ClassMember	Returns all possible foreign keys relevant for the given entity type, like for Order: 'Customer.FirstName' and 'Customer.LastName'.
ARCQuery.ForeignKey.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.ForeignKey.Steps	ARCQuery	ClassMember	The actual -ForeignKeySingleStep- leading to the -ForeignField-.
ARCQuery.ForeignKey.StepsAreOnlyDirectionToOne	ARCQuery	ClassMember	If TRUE then -TryGetPInternal) will use much simpler code without collections and parallell executions.
ARCQuery.FunctionKeyDouble.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyDouble.SyntaxHelp	ARCQuery	ClassMember	'Double()'
ARCQuery.FunctionKeyFirstLine	ARCQuery	Class	Extracts first line from string of text.
ARCQuery.FunctionKeyFirstLine.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyFirstLine.SyntaxHelp	ARCQuery	ClassMember	'FirstLine()'
ARCQuery.FunctionKeyVeryShort	ARCQuery	Class	Returns the -ToStringVeryShort- representation of the given type.
ARCQuery.FunctionKeyVeryShort.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyVeryShort.SyntaxHelp	ARCQuery	ClassMember	'VeryShort()'

Generated 2025-12-21 02:13:50.904 UTC