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

161 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
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+WildcardPositionType	ARCQuery	Enum	Position of wildcard in value, like 'ABC' (-AtStart-), 'ABC' (-AtEnd-) and
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart	ARCQuery	EnumMember	Example: '*ABC'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd	ARCQuery	EnumMember	Example: 'ABC*'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd	ARCQuery	EnumMember	Example: 'ABC'.
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-.
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
ARCQuery.ValueComparerDateTime+ResolutionEnum	ARCQuery	Enum
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Month	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Year	ARCQuery	EnumMember
Assembly ARCAPI		Assembly	A library providing an API on top of the -PropertyStream-.
ARCAPI.ContentResult	ARCAPI	Class	Mimicks Microsoft.AspNetCore.Mvc.ContentResult.
ARCAPI.ContentResult.CreateHTMLOK	ARCAPI	ClassMember	NOTE: Parameter must be a complete HTML page.
ARCAPI.ContentResult.CreateError	ARCAPI	ClassMember	TODO: Add a key / value format for error messages, like done for -Log-.
ARCAPI.AddController	ARCAPI	Class	Parses and stores a -PropertyStreamLine-.
ARCAPI.AddController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.AddController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.AddController.AllowFilter	ARCAPI	ClassMember	Describes what data is allowed to change through a list of -Subscription- instances.
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
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.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.
ARCQuery.ValueComparer.TryGetPrevious	ARCQuery	ClassMember	Suggestion for previous query (browsing 'backwards')
ARCQuery.ValueComparer.TryGetNext	ARCQuery	ClassMember	Suggestion for next query (browsing 'forwards')
ARCQuery.ValueComparerDateTime	ARCQuery	Class	-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.ValueComparerDateTime.TryGetPrevious	ARCQuery	ClassMember	Suggestion for previous query (browsing 'backwards')
ARCQuery.ValueComparerDateTime.TryGetNext	ARCQuery	ClassMember	Suggestion for next query (browsing 'forwards')
ARCQuery.ValueComparerDateTime.TryParse	ARCQuery	ClassMember	Note: This parser is probably exhaustive but not necessarily logical
ARCQuery.ValueComparerDateTime.Resolution	ARCQuery	ClassMember	See -ResolutionEnum-.
ARCQuery.ValueComparerDateTime.Steps	ARCQuery	ClassMember	Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.ValueComparerDateTime.IsGliding	ARCQuery	ClassMember	The modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCQuery.ValueComparerDateTime.IsBefore	ARCQuery	ClassMember	The modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCQuery.ValueComparerDateTime.IsAfter	ARCQuery	ClassMember	The modifier 'After' can be prepended in order to mean any time after the specified time.
ARCQuery.ValueComparerDateTime.IsInterval	ARCQuery	ClassMember	Normally the interval which is compared against is the timespan corresponding to -Resolution-.
ARCQuery.ValueComparerDateTime.InitValue	ARCQuery	ClassMember	For debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-.
ARCQuery.ValueComparerDateTime.StartPeriod	ARCQuery	ClassMember	The start of the interval which this instance compares against.
ARCQuery.ValueComparerDateTime.EndPeriod	ARCQuery	ClassMember	The end of the interval which this instance compares against.
ARCQuery.ValueComparerDateTime.ToDebugProperties	ARCQuery	ClassMember	Exposes all members of this class.
ARCQuery.ForeignKey+IKIPEqualityComparer	ARCQuery	Class	Used by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys
ARCQuery.ForeignKey+EntityTypeAndKey	ARCQuery	Class	Describes an entity type and a key.
ARCQuery.ForeignKey+EntityTypeAndKey.EntityType	ARCQuery	ClassMember	For -IPRelationsKeysPointingTo-, corresponds to foreign entity type.
ARCQuery.ForeignKey+EntityTypeAndKey.Key	ARCQuery	ClassMember	NOTE: Key in EntityTypeAndKey was relaxed from PK to IK 25 Feb 2022 in order for experiment in -ForeignKey- to work.
ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTerm	ARCQuery	ClassMember	Corresponds to -PKRelAttributeP-.- OppositeTerm-.
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}
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.QueryExpressionHint.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionHint.SyntaxHelp	ARCQuery	ClassMember	HINT {ON\|OFF}
ARCQuery.QueryExpressionLimit	ARCQuery	Class	Limits the final HTML presentation of results (limits the number of elements being presented).
ARCQuery.QueryExpressionLimit.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionLimit.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionLimit.SyntaxHelp	ARCQuery	ClassMember	Syntax: LIMIT {limit} like 'LIMIT 42'
ARCQuery.QueryExpressionLog	ARCQuery	Class	A debugging tool used to extract detailed log information about the execution of the query.
ARCQuery.QueryExpressionLog.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionLog.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionLog.SyntaxHelp	ARCQuery	ClassMember	'Log'.
ARCQuery.QueryExpressionOrderBy	ARCQuery	Class	Orders collection.
ARCQuery.QueryExpressionOrderBy.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionOrderBy.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionOrderBy.SyntaxHelp	ARCQuery	ClassMember	ORDER BY {key} [DESC] / [ASC]
ARCQuery.QueryExpressionPivot	ARCQuery	Class	Creates a table by querying over two keys like
ARCQuery.QueryExpressionPivot.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionPivot.GetCrossSummationChecker	ARCQuery	ClassMember	Returns a cross sum checker for int, long, double, Timespan.
ARCQuery.QueryExpressionPivot.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionPivot.SyntaxHelp	ARCQuery	ClassMember	1) 'PIVOT {rowKey} BY {columnKey}' like "PIVOT Colour BY Production.Year"
ARCQuery.QueryExpressionPivot.AggregationType	ARCQuery	ClassMember	Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCQuery.QueryExpressionPivot.AggregationKey	ARCQuery	ClassMember	This is often null (with -AggregationType- correspondingly set to Count-).
ARCQuery.QueryExpressionRel	ARCQuery	Class	Enables 'jumping' or 'travelling' from a collection of one entity type to another (related) entity type.
ARCQuery.QueryExpressionRel.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionRel.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.

Generated 2025-06-21 12:40:35.192 UTC