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

139 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
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.FunctionKeyYearWeek.SyntaxHelp	ARCQuery	ClassMember	'YearWeek()'
ARCQuery.NewKey	ARCQuery	Class	A function creating new keys (new fields) that can be used against all object types in AgoRapide (against all entities).
ARCQuery.NewKey.AddParser	ARCQuery	ClassMember	Adds an -ApplicationSpecificCode- parser.
ARCQuery.NewKey.TryParse	ARCQuery	ClassMember	Find parsers from -Parsers- based on first word in query.
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.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.
ARCQuery.QueryExpressionRel.SyntaxHelp	ARCQuery	ClassMember	'REL {type}'
ARCQuery.QueryExpressionRel.StrType	ARCQuery	ClassMember	In the simplest terms, the -ToStringVeryShort- representation of the type that we are 'jumping' to.
ARCQuery.QueryExpressionSelect	ARCQuery	Class	Selects which fields to include.
ARCQuery.QueryExpressionSelect.Execute	ARCQuery	ClassMember	Transforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionSelect.TryCheckForExistenceOfKey	ARCQuery	ClassMember	Used by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionSelect.SyntaxHelp	ARCQuery	ClassMember	SELECT {field-1}, {field-2} ... {field-n}
ARCQuery.QueryExpressionSelfCreate	ARCQuery	Class	Returns self created collection from given class type.
ARCQuery.QueryExpressionSelfCreate.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.
ARCCore.BaseAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.ClassAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.ClassMemberAttribute.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.EnumAttribute.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.EnumAttribute.IsDefault	ARCCore	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.)
ARCCore.Extensions.ForEach	ARCCore	ClassMember	Useful when we want to write collection.ForEach( ... ) instead of
ARCCore.Extensions.KeysAsString	ARCCore	ClassMember	Gives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.Extensions.SingleOrDefault	ARCCore	ClassMember	Same as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.Extensions.ToStringWithMS	ARCCore	ClassMember	Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCCore.IKCoded.FromEncoded	ARCCore	ClassMember	Note how uses instance cache if already exists there.
ARCCore.IKCoded.TryEncode	ARCCore	ClassMember	Returns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.IKDate.op_Equality	ARCCore	ClassMember	It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKDate.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.PKHTMLAttribute.Encode	ARCCore	ClassMember	Encodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PKHTMLAttribute.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.PKRelAttribute.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.PKRelAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PKTypeAttribute	ARCCore	Class	Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.
ARCCore.PKTypeAttribute.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.IP	ARCCore	Class	IP = IProperty.
ARCCore.IP.TryGetV Overload2	ARCCore	ClassMember	The actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.IP.HandleException	ARCCore	ClassMember	Note that most relevant to use for -PConcurrent-.
ARCCore.IP.TryParseDtr	ARCCore	ClassMember	Parses a PropertyStreamLine- beginning with -dtr-.
ARCCore.IP.TrySetPP	ARCCore	ClassMember	SetPP = set property of property. Sets property of entity contained within this class.
ARCCore.IP.GetKeysEqualToValue	ARCCore	ClassMember	Returns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.OnTrySetP	ARCCore	ClassMember	Event handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done).
ARCCore.IP.TryGetP	ARCCore	ClassMember	Gets a single property for this object
ARCCore.IP.TryGetPV	ARCCore	ClassMember	Gets a single property's value for the given property key.
ARCCore.IP.IsValid	ARCCore	ClassMember	Note that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'.
ARCCore.IP.Item	ARCCore	ClassMember	Offers string-based direct indexing.
ARCCore.IP.Keys	ARCCore	ClassMember	Returns all the keys for this instance.
ARCCore.P.ToString	ARCCore	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.ICreated	ARCCore	Class	A dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created-
ARCCore.PCollection	ARCCore	Class	A class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCCore.PCollection.TrySetPP	ARCCore	ClassMember	Replaces default interface method -TrySetPP-.
ARCCore.PExact<TEnumType>..ctor	ARCCore	ClassMember	Set capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value)
ARCCore.PExact<TEnumType>.Storage	ARCCore	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCCore.PII	ARCCore	Class	PII = property for storing individual items.
ARCCore.PII.TryGetV	ARCCore	ClassMember	Since value is stored in keys, we need to override this method.
ARCCore.PValue<T>.TrySetP	ARCCore	ClassMember	NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.PValue<T>.TryGetV	ARCCore	ClassMember	Supports duck typing.
ARCCore.PValue<T>.ConvertObjectToString	ARCCore	ClassMember	Converts object to string.
ARCCore.PValue<T>.ToString	ARCCore	ClassMember	Do no cache this value, because memory consumption would then increase significantly in your applicationj
ARCCore.ClientUpdatePosition	ARCCore	Class	Describes from WHERE (from WHEN) in the historic -PropertyStream- new data is to be returned.
ARCCore.ClientUpdatePosition.Filename	ARCCore	ClassMember	Filename like '2020-04-03 08:42:22_R001'
ARCCore.ClientUpdatePosition.Index	ARCCore	ClassMember	Index (zero-based) into file. Value of -1 means blank update status / no data received at all (or no data received for this specific filename)
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmpty	ARCCore	ClassMember	Used by the subscribing client to signify that it has no data stored locally, and it therefore needs an update from the beginning of the -PropertyStream-, that is, 'from the beginning of time'.
ARCCore.ConnectionInstruction.TryGetV	ARCCore	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).
ARCCore.ConnectionInstruction.ToString	ARCCore	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCCore.Sharding	ARCCore	Class	Enables load-balancing by describing what data should be sent over a given connection.
ARCCore.PropertyStreamLine	ARCCore	Class	Has two main functions:

Generated 2026-07-02 15:38:51.035 UTC