[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1033 > < TAKE 768 >
144 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
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-. |
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.NewKeyGetType.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
ARCQuery.NewKeyGetType.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
ARCQuery.NewKeyGetType.SyntaxHelp | ARCQuery | ClassMember | 'GetType()' |
ARCQuery.NewKeyGetType.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
ARCQuery.NewKeyGetType.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.NewKeyToPropertyStream | ARCQuery | Class | Returns the -PropertyStream- representation of the given object. |
ARCQuery.NewKeyToPropertyStream.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
ARCQuery.NewKeyToPropertyStream.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
ARCQuery.Query.ShouldTerminate | ARCQuery | ClassMember | Attempts to explain problem, in -TerminateReason- and by logging. |
ARCQuery.Query.ExecuteOne | ARCQuery | ClassMember | NOTE: Note how avoids deferred execution in order to always correctly time execution of each query element separately. |
ARCQuery.Query.AllLogEntriesForThisQuery | ARCQuery | ClassMember | Temporary storage of log information. |
ARCQuery.Query.Progress | ARCQuery | ClassMember | Use of member class in order for -Query- not to inherit -IP-. |
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.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.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.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. |
ARCQuery.QueryExpressionShuffle.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
ARCQuery.QueryExpressionShuffle.SyntaxHelp | ARCQuery | ClassMember | SHUFFLE |
ARCQuery.QueryExpressionSkip | ARCQuery | Class | Skips the specified number of elements from the current query result. |
ARCQuery.QueryExpressionSkip.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
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. |
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 21:52:56.795 UTC