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

178 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCQuery.EntityMethodKey+MethodType	ARCQuery	Enum	Explains type of method signature found (trough reflection) for corresponding entity class.
ARCAPI.ContentResult.CreateError	ARCAPI	ClassMember	TODO: Add a key / value format for error messages, like done for -Log-.
ARCQuery.EntityMethodKey+MethodType.Simple	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCAPI.AddController	ARCAPI	Class	Parses and stores a -PropertyStreamLine-.
ARCQuery.EntityMethodKey+MethodType.Complex	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCAPI.AddController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
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).
ARCAPI.AddController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+ValueEnum.NULL	ARCQuery	EnumMember
ARCAPI.AddController.AllowFilter	ARCAPI	ClassMember	Describes what data is allowed to change through a list of -Subscription- instances.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL	ARCQuery	EnumMember	Practical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCQuery.ValueComparerDateTime+ResolutionEnum	ARCQuery	Enum
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second	ARCQuery	EnumMember
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute	ARCQuery	EnumMember
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour	ARCQuery	EnumMember
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day	ARCQuery	EnumMember
ARCAPI.BaseController.GetTimestampIsOldWarningHTML	ARCAPI	ClassMember	If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week	ARCQuery	EnumMember
ARCAPI.BaseController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.Controllers.ControllerFacade.CatchAll Overload2	AgoMail	ClassMember	Catches all HTTP GET requests to this API.
ARCAPI.EditController	ARCAPI	Class	Offers a simple HTML editing environment of the raw -PropertyStream- from the given key.
AgoMail.Controllers.ControllerFacade.CatchAll Overload1	AgoMail	ClassMember	Catches all HTTP POST requests to this API.
ARCAPI.EditController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoMail.EmailP	AgoMail	Enum
ARCAPI.EditController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.EmailP.Date	AgoMail	EnumMember	UTC-format
ARCAPI.GQController	ARCAPI	Class	Offers GraphQL queries.
AgoMail.EmailP.From	AgoMail	EnumMember
ARCAPI.GQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoMail.EmailP.To	AgoMail	EnumMember
ARCAPI.GQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoMail.EmailP.CC	AgoMail	EnumMember
ARCAPI.RQController	ARCAPI	Class	RQ = REST Query. Executes a REST like query request against the given -DataStorage-.
AgoMail.EmailP.Subject	AgoMail	EnumMember
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-.
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
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.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.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.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.QueryExpressionOrderBy.Key	ARCQuery	ClassMember	TODO: Expand syntax to include multiple keys
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.
ARCCore.BaseAttribute.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.BaseAttribute.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.ClassMemberAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
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.IPAttribute	ARCCore	Class	Describes -IP- classes (describes at class-level)
ARCCore.Extensions.ToStringVeryShort	ARCCore	ClassMember	Returns same as -ToStringShort- but without any generics information at all.
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.IKIP.AssertTypeIntegrity	ARCCore	ClassMember	See -TryAssertTypeIntegrity- for documentation.
ARCCore.IKIP.TryAssertTypeIntegrity	ARCCore	ClassMember	Asserts that value is of correct type as specified by the key.
ARCCore.IKCoded.FromCacheEncoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKCoded.FromCacheUnencoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKString.FromCache	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKString.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
ARCCore.PK.TryGetEnum	ARCCore	ClassMember	Note that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key.
ARCCore.PK.FromEnum	ARCCore	ClassMember	Returns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK.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.PK..ctor	ARCCore	ClassMember	Constructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PKHTMLAttribute	ARCCore	Class	Contains pointer to HTML encoder for a property.
ARCCore.PKHTMLAttribute.Encode	ARCCore	ClassMember	Encodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.IHTMLEncoder	ARCCore	Class	Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.PKLogAttribute	ARCCore	Class	Explains how logging of changes to a property should be done.
ARCCore.PKRelAttribute	ARCCore	Class	Describes relationships between entities (between tables in RDBMS terms).
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.PKRelAttribute.ForeignEntity	ARCCore	ClassMember	See -ForeignEntity-.
ARCCore.PKTypeAttribute.Cardinality	ARCCore	ClassMember	See -Cardinality-.
ARCCore.PKTypeAttribute.DefaultValue	ARCCore	ClassMember	See -DefaultValue-.
ARCCore.PKTypeAttribute.IsObligatory	ARCCore	ClassMember	See -IsObligatory-.
ARCCore.PKTypeAttribute.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.IP.AssertIntegrity	ARCCore	ClassMember	See -TryAssertIntegrity-.
ARCCore.IP.TryAssertIntegrity	ARCCore	ClassMember	Asserts the integrity of this entity.
ARCCore.IP.ToString	ARCCore	ClassMember	The ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
ARCCore.IP.TrySetPP	ARCCore	ClassMember	SetPP = set property of property. Sets property of entity contained within this class.
ARCCore.IP.AllIPDerivedTypesWithPKEnum	ARCCore	ClassMember	All relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecific	ARCCore	ClassMember	All relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDict	ARCCore	ClassMember	All -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstract	ARCCore	ClassMember	All relevant -IP--derived types (except the interface -IP- itself) known to the application.

Generated 2025-11-07 23:14:14.417 UTC