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

192 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCQuery.QueryExpressionPivot.SyntaxHelp	ARCQuery	ClassMember	1) 'PIVOT {rowKey} BY {columnKey}' like "PIVOT Colour BY Production.Year"
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCQuery.QueryExpressionPivot.AggregationType	ARCQuery	ClassMember	Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.QueryExpressionPivot.AggregationKey	ARCQuery	ClassMember	This is often null (with -AggregationType- correspondingly set to Count-).
ARCQuery.ForeignKey+IKIPEqualityComparer	ARCQuery	Class	Used by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys
ARCQuery.ForeignKey+ForeignKeySingleStep	ARCQuery	Class
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignType	ARCQuery	ClassMember	The foreign type.
ARCQuery.ForeignKey+ForeignKeySingleStep.ActualForeignKey	ARCQuery	ClassMember	The actual foreign key like OrderId or CustomerId to use for this step
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntities	ARCQuery	ClassMember	The collection containing all the (foreign) entities for the type that this step leads to
ARCQuery.ForeignKeyDirection	ARCQuery	Enum	Describes the type of traversing to a foreign entity possible.
ARCQuery.ForeignKeyDirection.ToOne	ARCQuery	EnumMember	Traverse to one entity, like traversing from OrderLine to Order (based on OrderLine containing foreign key OrderId) or Order to Customer (based on Order containing foreign key CustomerId).
ARCQuery.ForeignKeyDirection.ToMany	ARCQuery	EnumMember	Traverse to many entities, like traversing from Customer to Order (based on Order containing foreign key CustomerId) or Order to OrderLine (based on OrderLine containing foreign key OrderId).
ARCQuery.AggregationType	ARCQuery	Enum	Used by -QueryExpressionPivot- and -QueryExpressionAggregate-.
ARCQuery.AggregationType.Count	ARCQuery	EnumMember
ARCQuery.AggregationType.Sum	ARCQuery	EnumMember
ARCQuery.RelationalOperator	ARCQuery	Enum	Relational / comparision operators.
ARCQuery.RelationalOperator.EQ	ARCQuery	EnumMember
ARCQuery.RelationalOperator.CONTAINS	ARCQuery	EnumMember
ARCQuery.RelationalOperator.NEQ	ARCQuery	EnumMember
ARCQuery.RelationalOperator.NOTCONTAINS	ARCQuery	EnumMember
ARCQuery.RelationalOperator.GT	ARCQuery	EnumMember
ARCQuery.RelationalOperator.LT	ARCQuery	EnumMember
ARCQuery.RelationalOperator.GEQ	ARCQuery	EnumMember
ARCQuery.RelationalOperator.LEQ	ARCQuery	EnumMember
ARCQuery.RelationalOperator.LIKE	ARCQuery	EnumMember	Case sensitive string wildcard comparision.
ARCQuery.RelationalOperator.ILIKE	ARCQuery	EnumMember	Case insensitive string wildcard comparision.
ARCQuery.RelationalOperator.NOTLIKE	ARCQuery	EnumMember	Case sensitive string wildcard comparision.
ARCQuery.RelationalOperator.NOTILIKE	ARCQuery	EnumMember	Case insensitive string wildcard comparision.
ARCQuery.Strictness	ARCQuery	Enum	Describes level of -Strictness- when executing query.
ARCQuery.Strictness.ON	ARCQuery	EnumMember
ARCQuery.Strictness.OFF	ARCQuery	EnumMember
ARCQuery.Quantile	ARCQuery	Enum	Describes quantiles like -TERTILE- and -QUARTILE-.
ARCQuery.Quantile.MEDIAN	ARCQuery	EnumMember	Divide into two parts
ARCQuery.Quantile.TERTILE	ARCQuery	EnumMember	Divide into three parts
ARCQuery.Quantile.QUARTILE	ARCQuery	EnumMember	Divide into four parts
ARCQuery.Quantile.QUINTILE	ARCQuery	EnumMember	Divide into five parts
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
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.ForeignKey.ForeignField	ARCQuery	ClassMember	The actual field in the final foreign entity to return value for.
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.FunctionKeyYearMonth	ARCQuery	Class	Extracts Year + Month component from field like 2020-06.
ARCQuery.FunctionKeyYearMonth.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyYearMonth.SyntaxHelp	ARCQuery	ClassMember	'YearMonth()'
ARCQuery.FunctionKeyYearQuarter	ARCQuery	Class	Extracts Year + Quarter component from field like 2020Q1.
ARCQuery.FunctionKeyYearQuarter.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyYearQuarter.SyntaxHelp	ARCQuery	ClassMember	'YearQuarter()'
ARCQuery.FunctionKeyYearWeek	ARCQuery	Class	Extract year and week number from field according to ISO 8601 like '2021-51'
ARCQuery.FunctionKeyYearWeek.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
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.Quantile.SEXTILE	ARCQuery	EnumMember	Divide into 6 parts
ARCQuery.Quantile.SEPTILE	ARCQuery	EnumMember	Divide into 7 parts
ARCQuery.Quantile.OCTILE	ARCQuery	EnumMember	Divide into 8 parts
ARCQuery.Quantile.DECILE	ARCQuery	EnumMember	Divide into 10 parts
ARCQuery.Quantile.DUODECILE	ARCQuery	EnumMember	Divide into 12 parts
ARCQuery.Quantile.HEXADECILE	ARCQuery	EnumMember	Divide into 16 parts
ARCQuery.Quantile.VENTILE	ARCQuery	EnumMember	Divide into 20 parts
ARCQuery.Quantile.PERCENTILE	ARCQuery	EnumMember	Divide into 100 parts
ARCQuery.Quantile.PERMILLE	ARCQuery	EnumMember	Divide into 1000 parts
ARCQuery.QueryProgressP	ARCQuery	Enum	Describes class -QueryProgress-.
ARCQuery.QueryProgressP.Queries	ARCQuery	EnumMember
ARCQuery.QueryProgressP.StrCurrentType	ARCQuery	EnumMember	Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCQuery.QueryProgressP.CurrentStrictness	ARCQuery	EnumMember	Describes -Strictness- ON / OFF when executing query.
ARCQuery.QueryProgressP.CreateHints	ARCQuery	EnumMember	Describes if hints are to be generated (as query progresses) for new queries.
ARCQuery.QueryProgressP.UseCache	ARCQuery	EnumMember	Describes if cache is to be used or not.
ARCQuery.QueryProgressP.Limit	ARCQuery	EnumMember	Limits the final HTML presentation of results (limits the number of elements being presented). Does not affect the query in itself. Used in order to avoid building huge HTML pages which will not be consumed anyway.
AgoMail.EmailP.TextBody	AgoMail	EnumMember
AgoMail.EmailP.HTMLBody	AgoMail	EnumMember
AgoMail.EmailP.Headers	AgoMail	EnumMember
AgoMail.EmailP.Attachments	AgoMail	EnumMember
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 AgoMail		Namespace
Namespace AgoMail.Controllers		Namespace
ARCAPI.ResponseFormat	ARCAPI	Enum	The response format, HTML or JSON, for an API request.
ARCQuery.FunctionKeyTMB.SyntaxHelp	ARCQuery	ClassMember	'TMB()'
ARCAPI.ResponseFormat.JSON	ARCAPI	EnumMember
ARCQuery.FunctionKeyTotalHours	ARCQuery	Class	Converts a timespan to total hours (as an integer).
ARCAPI.ResponseFormat.HTML	ARCAPI	EnumMember
ARCQuery.FunctionKeyTotalHours.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
Assembly AgoMail		Assembly
ARCQuery.FunctionKeyTotalHours.SyntaxHelp	ARCQuery	ClassMember	'TotalHours()'
AgoMail.Cleaner	AgoMail	Class
ARCQuery.FunctionKeyTotalMinutes	ARCQuery	Class	Converts a timespan to total minutes (as an integer).
AgoMail.Cleaner.Clean	AgoMail	ClassMember	Removes emails with often seen values for Subject, To or From.
ARCQuery.FunctionKeyTotalMinutes.TryGetP	ARCQuery	ClassMember	NOTE: The in-parameter is a property, not an entity.
AgoMail.Email	AgoMail	Class
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelp	ARCQuery	ClassMember	'TotalMinutes()'
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).
ARCQuery.FunctionKeyType	ARCQuery	Class	Returns the type of a property.
AgoMail.Email.ToString	AgoMail	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionSkip.SyntaxHelp	ARCQuery	ClassMember	SKIP {Count} like 'SKIP 42'
AgoMail.Program	AgoMail	Class	Application startup and initialization
ARCQuery.QueryExpressionStrict	ARCQuery	Class	Describes -Strictness- ON / OFF when executing query.
AgoMail.Program.InitStreamProcessor	AgoMail	ClassMember	Initializes stream processor.
ARCQuery.QueryExpressionStrict.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
AgoMail.Root	AgoMail	Class	Contains the user friendly welcome text (front page) for the application.
ARCQuery.QueryExpressionStrict.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
AgoMail.Root.ToHTMLSimpleSingle	AgoMail	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryExpressionStrict.SyntaxHelp	ARCQuery	ClassMember	STRICT {strictnessLevel}
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).
ARCQuery.QueryExpressionTake	ARCQuery	Class	Takes a specific number of elements from the current query result.
AgoMail.Root.ToString	AgoMail	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionTake.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
AgoMail.Controllers.ControllerFacade	AgoMail	Class	Facade for entry into the desired -BaseController-.
ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
AgoMail.Controllers.ControllerFacade.CatchAll Overload2	AgoMail	ClassMember	Catches all HTTP GET requests to this API.
ARCQuery.QueryExpressionTake.SyntaxHelp	ARCQuery	ClassMember	TAKE {Count}
AgoMail.Controllers.ControllerFacade.CatchAll Overload1	AgoMail	ClassMember	Catches all HTTP POST requests to this API.
ARCQuery.QueryExpressionWhere	ARCQuery	Class	Executes a 'WHERE {key} {operator} {value}' against the given collection.
AgoMail.EmailP	AgoMail	Enum
ARCQuery.QueryExpressionWhere.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
AgoMail.EmailP.Date	AgoMail	EnumMember	UTC-format
ARCQuery.QueryExpressionWhere.IsMatch	ARCQuery	ClassMember	Returns TRUE if property matches criteria.
AgoMail.EmailP.From	AgoMail	EnumMember
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
AgoMail.EmailP.To	AgoMail	EnumMember
ARCQuery.QueryExpressionWhere.SyntaxHelp	ARCQuery	ClassMember	WHERE {key} {operator} {value}
AgoMail.EmailP.CC	AgoMail	EnumMember
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.
AgoMail.EmailP.Subject	AgoMail	EnumMember
ARCQuery.QueryProgress	ARCQuery	Class	Keeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
ARCQuery.QueryProgress.ToJSONSerializeable	ARCQuery	ClassMember	Override of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCQuery.QueryProgress.PreviousQueryJustExecuted	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
ARCQuery.QueryProgress.NextQueryToExecute	ARCQuery	ClassMember	TODO: This is somewhat loosely associated.
ARCQuery.QueryProgress.ToHTMLSimpleSingle	ARCQuery	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryProgress.OrderAndReconstructKeys	ARCQuery	ClassMember	Part 1:
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryParts	ARCQuery	ClassMember	Is able to generate the following:
ARCQuery.QueryProgress.ToString	ARCQuery	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgress.Result	ARCQuery	ClassMember	This gets updated continously as the different query expressions get evaluated.
ARCQuery.QueryProgress.ExecutedQueries	ARCQuery	ClassMember	The result from calling -Execute- for each query in -Queries-.
ARCQuery.QueryProgress.AdditionalJavascriptUrlEncoder	ARCQuery	ClassMember	Returns the Javascript code for converting characters that are difficult to pass in URLs to a format understood by -Decode-.
ARCQuery.UtilQuery	ARCQuery	Class	Utility methods for -ARCQuery-.
ARCQuery.UtilQuery.IndexOfOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.UtilQuery.IndexOfAnyOutsideOf	ARCQuery	ClassMember	Equivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
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.UtilQuery.SpecialLinkPrefixes	ARCQuery	ClassMember	Contains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.ValueComparer	ARCQuery	Class	Can evaluation expressions like 'WHERE Created = ThisYear.
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"]).

Generated 2026-11-06 02:30:26.782 UTC