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

130 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.DataStorage	ARCAPI	Class	The all-in-memory global application data storage.
ARCAPI.ContentResult	ARCAPI	Class	Mimicks Microsoft.AspNetCore.Mvc.ContentResult.
ARCAPI.DataStorage.DocLinks	ARCAPI	ClassMember	Note that may be null.
ARCAPI.ContentResult.CreateError	ARCAPI	ClassMember	TODO: Add a key / value format for error messages, like done for -Log-.
ARCAPI.DataStorage.Lock	ARCAPI	ClassMember	Locking object for thread-safe access from simultaneous API requests.
ARCAPI.AddController	ARCAPI	Class	Parses and stores a -PropertyStreamLine-.
ARCAPI.DataStorage.ExternalReceiver	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.AddController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.DataStorage.DoNotStoreInternally	ARCAPI	ClassMember	Typically used by -AddController-.
ARCAPI.AddController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.ResponseFormat	ARCAPI	Enum	The response format, HTML or JSON, for an API request.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCAPI.ResponseFormat.JSON	ARCAPI	EnumMember
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.ResponseFormat.HTML	ARCAPI	EnumMember
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
Assembly AgoBrowse		Assembly
ARCAPI.BaseController.GetTimestampIsOldWarningHTML	ARCAPI	ClassMember	If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
AgoBrowse.Program	AgoBrowse	Class
ARCAPI.EditController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Program.InitStreamProcessor	AgoBrowse	ClassMember	Initializes stream processor.
ARCAPI.EditController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Root.ToString	AgoBrowse	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-.
AgoBrowse.Controllers.CompileController	AgoBrowse	Class	Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
ARCAPI.RQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.APIMethod	AgoBrowse	ClassMember	The (only) API method that this controller supports.
ARCAPI.DataStorage.Create	ARCAPI	ClassMember	Creates a -DataStorage- instance with default parameters.
AgoBrowse.Controllers.CompileController.Compile	AgoBrowse	ClassMember	Compiles a hierarchical 'picture book' from the given parameter.
ARCAPI.DataStorage..ctor	ARCAPI	ClassMember	This method will:
AgoBrowse.Controllers.CompileController.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.DataStorage.Storage	ARCAPI	ClassMember	The actual storage.
AgoBrowse.Controllers.ControllerFacade	AgoBrowse	Class	Facade for entry into the desired -RQController-.
ARCAPI.DataStorage.ControllerStorage	ARCAPI	ClassMember	Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCAPI.BaseControllerP	ARCAPI	Enum	Describes class -BaseController-.
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
ARCAPI.BaseControllerP.CountRequest	ARCAPI	EnumMember	Number of calls to -APIMethod- since application initialization
Namespace AgoBrowse		Namespace
ARCAPI.BaseControllerP.CountException	ARCAPI	EnumMember	Number of exceptions at call to -APIMethod- since application initialization
Namespace AgoBrowse.Controllers		Namespace
ARCAPI.BaseControllerP.LogLevel	ARCAPI	EnumMember
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.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.
ARCQuery.QueryProgressP.Title	ARCQuery	EnumMember	The title to be used in the final presentation of the query result.
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.LinkAdjustment	ARCQuery	EnumMember	Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level).
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.
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.
ARCQuery.QueryProgressP.AllLogEntriesForThisQuery	ARCQuery	EnumMember
ARCQuery.TranslationsP	ARCQuery	Enum	This enum has no values because the keys are the actual string to be translated.
ARCQuery.TranslationSingleP	ARCQuery	Enum	Describes class -TranslationSingle-.
ARCQuery.TranslationSingleP.Text	ARCQuery	EnumMember
ARCQuery.TranslationSingleP.IsMissing	ARCQuery	EnumMember	Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing.
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+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-.
ARCDoc.DocLinkResolutionCollection	ARCDoc	Class	Contains a collection of -DocLinkResolution- objects.
ARCDoc.DocLinkResolutionCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkResolutionCollection.TryGetV	ARCDoc	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).
ARCDoc.DocLinkResolutionCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator	ARCDoc	Class	General class for documenting AgoRapide and also your own -ApplicationSpecificCode-.
ARCDoc.Documentator.CreateAndInsert	ARCDoc	ClassMember	Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies.
ARCDoc.Documentator.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.Documentator.CreateHTOCStandard	ARCDoc	ClassMember	Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'.
ARCDoc.Documentator.CreateHTOCNamespace	ARCDoc	ClassMember	Creates a table of contents structured by namespace
ARCDoc.Documentator.CreateHTOCInheritance	ARCDoc	ClassMember	Creates a table of contents structured by inheritance (classes and interfaces only, not members).
ARCDoc.Documentator.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.Documentator.TryGetV	ARCDoc	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).
ARCDoc.Documentator.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Documentator.DocLinks	ARCDoc	ClassMember	Set by -CreateAndInsert-.
ARCDoc.Documentator.DocLinkResolutionLocation	ARCDoc	ClassMember	Default position within the global storage context of doc link resolution pages.
ARCDoc.DummyEnum	ARCDoc	Class	TODO: Document better what this is for (and change name)
ARCDoc.DummyEnum.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DummyEnum.TryGetV	ARCDoc	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).
ARCDoc.DummyEnum.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.Extensions	ARCDoc	Class	Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML.
ARCDoc.Extensions.ToHTMLSimpleSingleRecursive	ARCDoc	ClassMember	Calls -ToHTMLSimpleSingle- recursively.
ARCDoc.Extensions.ToHTMLSimpleSingle	ARCDoc	ClassMember	Creates a simple HTML representation of the given parameter.
ARCDoc.Extensions.ToHTMLSimpleSingleInternal	ARCDoc	ClassMember	Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
ARCDoc.Extensions.ToHTMLSimpleAsTableRow	ARCDoc	ClassMember	Creates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table.
ARCDoc.Extensions.DescribeValue	ARCDoc	ClassMember	Describes the value contained withing an -IKIP- (-P-).
ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip	ARCDoc	ClassMember	Creates a simple HTML representation of the Value with description as a 'tooltip'.
ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip	ARCDoc	ClassMember	Creates a simple HTML representation of the Key with description as a 'tooltip'.
ARCDoc.Extensions.GetHelptextHTML	ARCDoc	ClassMember	Returns content of -Description- and -LongDescription-.
ARCDoc.HLocation	ARCDoc	Class	Simple class describing the location of a single -IP- instance within some hierarhical context.
ARCDoc.HLocation.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HLocation.TryGetV	ARCDoc	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).
ARCDoc.HLocation.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocation.Content	ARCDoc	ClassMember	The Content object is not stored within the standard -IP--mechanism.
ARCDoc.HLocationCollection	ARCDoc	Class	Contains a collection of -HLocation- objects.
ARCDoc.HLocationCollection.Create	ARCDoc	ClassMember	Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk	ARCDoc	ClassMember	Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.HLocationCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HLocationCollection.TryGetV	ARCDoc	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).
ARCDoc.HLocationCollection.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOC	ARCDoc	Class	HTOC = Hierarchical table of contents.
ARCDoc.HTOC.Create	ARCDoc	ClassMember	Structures content hierarchically according to the criteria for each level.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1	ARCDoc	ClassMember	Use this method in any class where a table-of-contents type of view is desireable
ARCDoc.HTOC.CreateInitialContent	ARCDoc	ClassMember	Helper method for creation of a -FilterBranch-.
ARCDoc.HTOC.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HTOC.TryGetV	ARCDoc	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).
ARCDoc.HTOC.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOC.HTOCContentThisLevelKey	ARCDoc	ClassMember	The key used for storing the actual content at this level.
ARCDoc.PKDocAttribute	ARCDoc	Class	Describes documentation and presentation of a property.
ARCDoc.PKDocAttribute.Initialize	ARCDoc	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.
ARCDoc.PKDocAttribute.TryRemoveP	ARCDoc	ClassMember	Should probably never be used.
ARCDoc.PKDocAttribute.PriorityOrder	ARCDoc	ClassMember	See -PriorityOrder-.
ARCDoc.PKDocAttribute.IsDefault	ARCDoc	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.)
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.

Generated 2025-07-11 02:16:25.229 UTC