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

154 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
Namespace AgoMail		Namespace
ARCQuery.QueryProgressP.TerminateReason	ARCQuery	EnumMember	The reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it.
Namespace AgoMail.Controllers		Namespace
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery	ARCQuery	EnumMember
ARCQuery.EntityMethodKey+MethodType	ARCQuery	Enum	Explains type of method signature found (trough reflection) for corresponding entity class.
ARCQuery.EntityMethodKey+MethodType.Simple	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCQuery.EntityMethodKey+MethodType.Complex	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
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.QueryExpressionWhere+ValueEnum.NULL	ARCQuery	EnumMember
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL	ARCQuery	EnumMember	Practical value enabling suggestions from -GetPrevious- and -GetNext-.
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 AgoMail		Assembly
AgoMail.Cleaner	AgoMail	Class
AgoMail.Cleaner.Clean	AgoMail	ClassMember	Removes emails with often seen values for Subject, To or From.
AgoMail.Email	AgoMail	Class
AgoMail.Email.TryGetV	AgoMail	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).
AgoMail.Email.ToString	AgoMail	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.Program	AgoMail	Class	Application startup and initialization
AgoMail.Program.InitStreamProcessor	AgoMail	ClassMember	Initializes stream processor.
AgoMail.Root	AgoMail	Class	Contains the user friendly welcome text (front page) for the application.
AgoMail.Root.ToHTMLSimpleSingle	AgoMail	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
AgoMail.Root.TryGetV	AgoMail	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).
AgoMail.Root.ToString	AgoMail	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.Controllers.ControllerFacade	AgoMail	Class	Facade for entry into the desired -BaseController-.
ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.OrdinaryKeyPlusFunctionOrQuantile.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.Extensions	ARCQuery	Class
ARCQuery.Extensions.TryGetP	ARCQuery	ClassMember	Same functionality as -TryGetP- but understands the concept of -CompoundKey-.
ARCQuery.FunctionKeyAggregate	ARCQuery	Class	Operates over a collection of properties.
ARCQuery.FunctionKeyAggregate.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyAggregateAvg	ARCQuery	Class	Calculates the average of the given properties.
ARCQuery.FunctionKeyAggregateAvg.SyntaxHelp	ARCQuery	ClassMember	'Avg()'
ARCQuery.FunctionKeyHourMinute.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyHourMinute.SyntaxHelp	ARCQuery	ClassMember	'HourMinute()'
ARCQuery.FunctionKeyInt	ARCQuery	Class	Rounds a double value to the nearest integer (uses .NET data type Int64 (long)).
ARCQuery.FunctionKeyInt.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyInt.SyntaxHelp	ARCQuery	ClassMember	'Int()'
ARCQuery.FunctionKeyLength	ARCQuery	Class	Returns length of (string) value of field, like 4 for 'John'.
ARCQuery.FunctionKeyLength.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
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.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.FunctionKeyWeek.SyntaxHelp	ARCQuery	ClassMember	'Week()'
ARCQuery.FunctionKeyYear	ARCQuery	Class	Extracts Year-component from field.
ARCQuery.FunctionKeyYear.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyYear.SyntaxHelp	ARCQuery	ClassMember	'Year()'
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}'.
ARCQuery.NewKeyToPropertyStream.TryGetP	ARCQuery	ClassMember	The outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKeyToPropertyStream.SyntaxHelp	ARCQuery	ClassMember	'ToPropertyStream()'
ARCQuery.NewKeyToPropertyStream.FunctionKeys	ARCQuery	ClassMember	All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.NewKeyToPropertyStream.QuantileKey	ARCQuery	ClassMember	Eventual final -QuantileKey- at end of compound key.
ARCQuery.QuantileKey	ARCQuery	Class	Can separate entities into quantiles, like Quartiles, Quintiles or Sextiles.
ARCQuery.QuantileKey.TryGetP	ARCQuery	ClassMember	Returns an integer with the number of the quantile group for the value returned by the given -CompoundKey-).
ARCQuery.QuantileKey.TryParse	ARCQuery	ClassMember	Note that any value (positive integer greated than 2) is accepted, not necessarily only string-representations of enums within -Quantile-.
ARCQuery.Query	ARCQuery	Class	Keeps track of progress of query, and the interim result.
ARCQuery.Query.ShouldTerminate	ARCQuery	ClassMember	Attempts to explain problem, in -TerminateReason- and by logging.
ARCQuery.Query.ExecuteOne	ARCQuery	ClassMember	NOTE: Note how avoids deferred execution in order to always correctly time execution of each query element separately.
ARCQuery.Query.AllLogEntriesForThisQuery	ARCQuery	ClassMember	Temporary storage of log information.
ARCQuery.Query.Progress	ARCQuery	ClassMember	Use of member class in order for -Query- not to inherit -IP-.
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.DocLinkResolutionP.DocLinks	ARCDoc	EnumMember	The possible links for -LinkWord-
ARCDoc.DocumentatorP	ARCDoc	Enum	Describes class -Documentator-.
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-.
ARCDoc.PriorityOrder	ARCDoc	Enum	Used for general sorting / prioritizing when showing properties for an entity.
ARCDoc.PriorityOrder.NotImportant	ARCDoc	EnumMember
ARCDoc.PriorityOrder.Important	ARCDoc	EnumMember
Assembly ARCQuery		Assembly	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.BinaryOperatorKey	ARCQuery	Class	Offers expressions with operators like +, -, * and /.
ARCQuery.BinaryOperatorKey.TryGetPInternal	ARCQuery	ClassMember	The internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.QueryExpression	ARCQuery	Class	Represents part of a query (or actually a transformation) against a given collection and the data storage from which it was taken.
ARCQuery.QueryExpression.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpression.AddParser	ARCQuery	ClassMember	Adds a -ApplicationSpecificCode- parser.
ARCQuery.QueryExpression.TryParse	ARCQuery	ClassMember	Find parsers from -Parsers- based on first word in query.
ARCQuery.QueryExpression.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpression.Parsers	ARCQuery	ClassMember	Parsers for all the relevant sub classes of -QueryExpression-.
ARCQuery.QueryExpressionWithSuggestions	ARCQuery	Class	Keeps track as each query item gets executed.
ARCQuery.QueryExpressionWithSuggestions.Previous	ARCQuery	ClassMember	Suggestion for a 'browse backwards' button.
ARCQuery.QueryExpressionWithSuggestions.Next	ARCQuery	ClassMember	Suggestion for a 'browse forwards' button.
ARCQuery.QueryExpressionAggregate	ARCQuery	Class	Aggregates over the given key.
ARCQuery.QueryExpressionAggregate.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionAggregate.IsSuitableAggregator	ARCQuery	ClassMember	Returns true if
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}

Generated 2026-11-04 12:39:22.379 UTC