[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() SKIP 995

182 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery	ARCQuery	EnumMember
ARCQuery.QueryExpressionAggregate.SyntaxHelp	ARCQuery	ClassMember	1) 'AGGREGATE {rowKey}' like "AGGREGATE Product"
ARCQuery.TranslationsP	ARCQuery	Enum	This enum has no values because the keys are the actual string to be translated.
ARCQuery.QueryExpressionAggregate.AggregationType	ARCQuery	ClassMember	Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCQuery.TranslationSingleP	ARCQuery	Enum	Describes class -TranslationSingle-.
ARCQuery.QueryExpressionAggregate.AggregationKey	ARCQuery	ClassMember	This is often null (with -AggregationType- correspondingly set to Count-).
ARCQuery.TranslationSingleP.Text	ARCQuery	EnumMember
ARCQuery.QueryExpressionAll	ARCQuery	Class	Represents all entities for a given collection.
ARCQuery.TranslationSingleP.IsMissing	ARCQuery	EnumMember	Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing.
ARCQuery.QueryExpressionAll.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.EntityMethodKey+MethodType	ARCQuery	Enum	Explains type of method signature found (trough reflection) for corresponding entity class.
ARCQuery.QueryExpressionAll.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.EntityMethodKey+MethodType.Simple	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCQuery.QueryExpressionAll.SyntaxHelp	ARCQuery	ClassMember	'ALL' (literally).
ARCQuery.EntityMethodKey+MethodType.Complex	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCQuery.TranslationsCollection.GetKeysEqualToValue	ARCQuery	ClassMember	Returns properties which themselves again have key and value equal to the given key and value.
ARCQuery.QueryExpressionWhere+WildcardPositionType	ARCQuery	Enum	Position of wildcard in value, like 'ABC' (-AtStart-), 'ABC' (-AtEnd-) and
ARCQuery.TranslationsCollection.TryGetP	ARCQuery	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart	ARCQuery	EnumMember	Example: '*ABC'.
ARCQuery.TranslationsCollection.TryGetV	ARCQuery	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.QueryExpressionWhere+WildcardPositionType.AtEnd	ARCQuery	EnumMember	Example: 'ABC*'.
ARCQuery.TranslationsCollection.ToString	ARCQuery	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd	ARCQuery	EnumMember	Example: 'ABC'.
ARCQuery.TranslationSingle	ARCQuery	Class	Describes a single translation.
ARCQuery.QueryExpressionWhere+ValueEnum	ARCQuery	Enum	Helper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
ARCQuery.TranslationSingle.TryGetReferenceCount	ARCQuery	ClassMember	Method signature understood by -TryGetP- / -EntityMethodKey-.
ARCQuery.QueryExpressionWhere+ValueEnum.NULL	ARCQuery	EnumMember
ARCQuery.TranslationSingle.TryGetPS	ARCQuery	ClassMember	Returns a -PropertyStreamLine- representation of this translation.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL	ARCQuery	EnumMember	Practical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCQuery.TranslationSingle.TryGetA	ARCQuery	ClassMember	Returns a -PropertyStreamLine- representation of this translation.
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
ARCQuery.TranslationSingle.TryGetMacro	ARCQuery	ClassMember	Returns a -PropertyStream- representation of this translation.
ARCQuery.ValueComparerDateTime+ResolutionEnum	ARCQuery	Enum
ARCQuery.TranslationSingle.TryGetP	ARCQuery	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second	ARCQuery	EnumMember
ARCQuery.TranslationSingle.TryGetV	ARCQuery	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.ValueComparerDateTime+ResolutionEnum.Minute	ARCQuery	EnumMember
ARCQuery.TranslationSingle.ToString	ARCQuery	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour	ARCQuery	EnumMember
ARCQuery.TranslationSingle.ReferenceCount	ARCQuery	ClassMember	May be set from outside, for instance with System.Threading.Interlocked.Increment.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day	ARCQuery	EnumMember
ARCQuery.UtilQuery	ARCQuery	Class	Utility methods for -ARCQuery-.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week	ARCQuery	EnumMember
ARCQuery.UtilQuery.IndexOfOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Month	ARCQuery	EnumMember
ARCQuery.UtilQuery.IndexOfAnyOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter	ARCQuery	EnumMember
ARCQuery.UtilQuery.SplitOutsideOf	ARCQuery	ClassMember	Equivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Year	ARCQuery	EnumMember
ARCQuery.UtilQuery.SpecialLinkPrefixes	ARCQuery	ClassMember	Contains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
Assembly ARCAPI		Assembly	A library providing an API on top of the -PropertyStream-.
ARCQuery.ValueComparer	ARCQuery	Class	Can evaluation expressions like 'WHERE Created = ThisYear.
ARCAPI.ContentResult	ARCAPI	Class	Mimicks Microsoft.AspNetCore.Mvc.ContentResult.
ARCQuery.ValueComparer.TryGetPrevious	ARCQuery	ClassMember	Suggestion for previous query (browsing 'backwards')
ARCAPI.ContentResult.CreateHTMLOK	ARCAPI	ClassMember	NOTE: Parameter must be a complete HTML page.
ARCQuery.ValueComparer.TryGetNext	ARCQuery	ClassMember	Suggestion for next query (browsing 'forwards')
ARCAPI.ContentResult.CreateError	ARCAPI	ClassMember	TODO: Add a key / value format for error messages, like done for -Log-.
ARCQuery.ValueComparerDateTime	ARCQuery	Class	-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCAPI.AddController	ARCAPI	Class	Parses and stores a -PropertyStreamLine-.
ARCQuery.ValueComparerDateTime.TryGetPrevious	ARCQuery	ClassMember	Suggestion for previous query (browsing 'backwards')
ARCAPI.AddController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.ValueComparerDateTime.TryGetNext	ARCQuery	ClassMember	Suggestion for next query (browsing 'forwards')
ARCAPI.AddController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.ValueComparerDateTime.TryParse	ARCQuery	ClassMember	Note: This parser is probably exhaustive but not necessarily logical
ARCAPI.AddController.AllowFilter	ARCAPI	ClassMember	Describes what data is allowed to change through a list of -Subscription- instances.
ARCQuery.ValueComparerDateTime.Resolution	ARCQuery	ClassMember	See -ResolutionEnum-.
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCQuery.ValueComparerDateTime.Steps	ARCQuery	ClassMember	Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCQuery.ValueComparerDateTime.IsGliding	ARCQuery	ClassMember	The modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.ValueComparerDateTime.IsBefore	ARCQuery	ClassMember	The modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCQuery.ValueComparerDateTime.IsAfter	ARCQuery	ClassMember	The modifier 'After' can be prepended in order to mean any time after the specified time.
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCQuery.ValueComparerDateTime.IsInterval	ARCQuery	ClassMember	Normally the interval which is compared against is the timespan corresponding to -Resolution-.
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.ValueComparerDateTime.InitValue	ARCQuery	ClassMember	For debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-.
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.
ARCAPI.BaseController.GetTimestampIsOldWarningHTML	ARCAPI	ClassMember	If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
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).
ARCAPI.BaseController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Root.ToString	AgoBrowse	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.
AgoBrowse.Controllers.CompileController	AgoBrowse	Class	Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
ARCAPI.EditController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.APIMethod	AgoBrowse	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.
AgoBrowse.Controllers.CompileController.Compile	AgoBrowse	ClassMember	Compiles a hierarchical 'picture book' from the given parameter.
ARCAPI.GQController	ARCAPI	Class	Offers GraphQL queries.
AgoBrowse.Controllers.CompileController.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.GQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Controllers.ControllerFacade	AgoBrowse	Class	Facade for entry into the desired -RQController-.
ARCAPI.GQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
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
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-.
ARCQuery.FunctionKeyLength.SyntaxHelp	ARCQuery	ClassMember	'Length()'
ARCQuery.FunctionKeyMonth	ARCQuery	Class	Extracts month component from field like '2020-12-09' becoming '12'.
ARCQuery.FunctionKeyMonth.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyMonth.SyntaxHelp	ARCQuery	ClassMember	'Month()'
ARCQuery.FunctionKeyQuarter	ARCQuery	Class	Extracts quarter component from datetime field like '2020-12-09' becoming 'Q4'.
ARCQuery.FunctionKeyQuarter.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyQuarter.SyntaxHelp	ARCQuery	ClassMember	'Quarter()'
ARCQuery.FunctionKeyShort	ARCQuery	Class	'Smart' way of showing time. Removes unnecessary information.
ARCQuery.FunctionKeyShort.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyShort.SyntaxHelp	ARCQuery	ClassMember	'Short()'
ARCQuery.FunctionKeyTMB	ARCQuery	Class	TMB = Thousands, Millions, Billions.
ARCQuery.FunctionKeyTMB.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyTMB.SyntaxHelp	ARCQuery	ClassMember	'TMB()'
ARCQuery.FunctionKeyTotalHours	ARCQuery	Class	Converts a timespan to total hours (as an integer).
ARCQuery.FunctionKeyTotalHours.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyTotalHours.SyntaxHelp	ARCQuery	ClassMember	'TotalHours()'
ARCQuery.FunctionKeyTotalMinutes	ARCQuery	Class	Converts a timespan to total minutes (as an integer).
ARCQuery.FunctionKeyTotalMinutes.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelp	ARCQuery	ClassMember	'TotalMinutes()'
ARCQuery.FunctionKeyType	ARCQuery	Class	Returns the type of a property.
ARCQuery.FunctionKeyType.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyType.SyntaxHelp	ARCQuery	ClassMember	'Type()'
ARCQuery.FunctionKeyWeek	ARCQuery	Class	Extract week-number from field according to ISO 8601.
ARCQuery.FunctionKeyWeek.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.NewKey.TryParseSingleWord	ARCQuery	ClassMember	Recommended parser to use for functions without parameters.
ARCQuery.NewKey.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKey.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.NewKey.ToString	ARCQuery	ClassMember	The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.NewKey.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.NewKey.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.NewKey.Parsers	ARCQuery	ClassMember	Instances of all the relevant sub classes of -NewKey-.
ARCQuery.NewKeyCountP	ARCQuery	Class	Returns the number of properties for a given entity object.
ARCQuery.NewKeyCountP.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.NewKeyCountP.ToString	ARCQuery	ClassMember	The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.NewKeyCountP.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKeyCountP.SyntaxHelp	ARCQuery	ClassMember	'CountP()'
ARCQuery.NewKeyCountP.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.NewKeyCountP.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.NewKeyCountPRec	ARCQuery	Class	Returns the number of properties for a given entity object.
ARCQuery.NewKeyCountPRec.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.NewKeyCountPRec.CountPRec	ARCQuery	ClassMember	Counts recursively the number of properties for a given entity object.
ARCQuery.NewKeyCountPRec.ToString	ARCQuery	ClassMember	The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.NewKeyCountPRec.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKeyCountPRec.SyntaxHelp	ARCQuery	ClassMember	'CountPRec()'
ARCQuery.NewKeyCountPRec.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.NewKeyCountPRec.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.NewKeyGetType	ARCQuery	Class	Returns the internal C# object type of the given object.
ARCQuery.NewKeyGetType.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.NewKeyGetType.ToString	ARCQuery	ClassMember	The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.NewKeyGetType.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKeyGetType.SyntaxHelp	ARCQuery	ClassMember	'GetType()'
ARCQuery.NewKeyGetType.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.NewKeyGetType.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.NewKeyToPropertyStream	ARCQuery	Class	Returns the -PropertyStream- representation of the given object.
ARCQuery.NewKeyToPropertyStream.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.NewKeyToPropertyStream.ToString	ARCQuery	ClassMember	The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.

Generated 2026-07-02 14:42:06.812 UTC