[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1093 > < TAKE 112 >
112 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| 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 ARAdventureWorksOLAP | Assembly | ||
| ARAdventureWorksOLAP.Converter | ARAdventureWorksOLAP | Class | Converts original sample database to property stream format. |
| ARAdventureWorksOLAP.Converter.ConvertDatabase | ARAdventureWorksOLAP | ClassMember | Converts original sample database to property stream format if no data for 'DimCustomer' found. |
| ARAdventureWorksOLAP.DimAccount | ARAdventureWorksOLAP | Class | Represents an Account. See also -DimAccountP- and -DimAccountCollection-. |
| ARAdventureWorksOLAP.DimAccount.SetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccount.GetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccount.TryGetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccount.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARAdventureWorksOLAP.DimAccount.Storage | ARAdventureWorksOLAP | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARAdventureWorksOLAP.DimAccountCollection | ARAdventureWorksOLAP | Class | The existence of this class ensures that -Indexing- will be used for foreign key -ParentDimAccountId-. |
| ARAdventureWorksOLAP.DimAccountCollection.TrySetPP | ARAdventureWorksOLAP | ClassMember | Replaces default interface method -TrySetPP-. |
| ARAdventureWorksOLAP.DimAccountCollection.GetKeysEqualToValue | ARAdventureWorksOLAP | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARAdventureWorksOLAP.DimAccountCollection.TryGetP | ARAdventureWorksOLAP | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARAdventureWorksOLAP.DimDepartment.Storage | ARAdventureWorksOLAP | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARAdventureWorksOLAP.DimDepartmentCollection | ARAdventureWorksOLAP | Class | The existence of this class ensures that -Indexing- will be used for foreign key -ParentDimDepartmentId-. |
| ARAdventureWorksOLAP.DimDepartmentCollection.TrySetPP | ARAdventureWorksOLAP | ClassMember | Replaces default interface method -TrySetPP-. |
| ARAdventureWorksOLAP.DimDepartmentCollection.GetKeysEqualToValue | ARAdventureWorksOLAP | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARAdventureWorksOLAP.DimDepartmentCollection.TryGetP | ARAdventureWorksOLAP | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARAdventureWorksOLAP.DimDepartmentCollection.TryGetV | ARAdventureWorksOLAP | 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). |
| ARAdventureWorksOLAP.DimDepartmentCollection.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARAdventureWorksOLAP.DimEmployee | ARAdventureWorksOLAP | Class | Represents an Employee. See also -DimEmployeeP- and -DimEmployeeCollection-. |
| ARAdventureWorksOLAP.DimEmployee.TryGetName | ARAdventureWorksOLAP | ClassMember | Adds together Title, LastName, FirstName, MiddleName |
| ARCQuery.QueryProgressP.Title | ARCQuery | EnumMember | The title to be used in the final presentation of the query result. |
| ARAdventureWorksOLAP.DimEmployee.SetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
| ARAdventureWorksOLAP.DimEmployee.GetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
| ARAdventureWorksOLAP.DimEmployee.TryGetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
| ARAdventureWorksOLAP.DimEmployee.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
| ARAdventureWorksOLAP.DimEmployee.Storage | ARAdventureWorksOLAP | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
| ARAdventureWorksOLAP.DimEmployeeCollection | ARAdventureWorksOLAP | Class | The existence of this class ensures that -Indexing- will be used for foreign keys -ParentEmployeeId- and -DimSalesTerritoryId-. |
| ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
| ARAdventureWorksOLAP.DimEmployeeCollection.TrySetPP | ARAdventureWorksOLAP | ClassMember | Replaces default interface method -TrySetPP-. |
| 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. |
| ARAdventureWorksOLAP.DimEmployeeCollection.GetKeysEqualToValue | ARAdventureWorksOLAP | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| 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. |
| ARAdventureWorksOLAP.DimEmployeeCollection.TryGetP | ARAdventureWorksOLAP | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
| ARAdventureWorksOLAP.DimEmployeeCollection.TryGetV | ARAdventureWorksOLAP | 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). |
| ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
| ARAdventureWorksOLAP.DimEmployeeCollection.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
| ARAdventureWorksOLAP.DimGeography | ARAdventureWorksOLAP | Class | Represents a Geography location. See also -DimGeographyP-. |
| ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
| ARAdventureWorksOLAP.DimGeography.TryGetCountry | ARAdventureWorksOLAP | ClassMember | Returns EnglishCountryName. |
| 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. |
| ARAdventureWorksOLAP.DimGeography.TryGetState | ARAdventureWorksOLAP | ClassMember | Returns StateOrProvinceName. |
| ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
| ARAdventureWorksOLAP.DimGeography.TryGetStateCode | ARAdventureWorksOLAP | ClassMember | Returns StateOrProvinceCode. |
| ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
| ARAdventureWorksOLAP.DimGeography.TryGetProvince | ARAdventureWorksOLAP | ClassMember | Returns StateOrProvinceName. |
| ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
| ARAdventureWorksOLAP.DimGeography.TryGetProvinceCode | ARAdventureWorksOLAP | ClassMember | Returns StateOrProvinceCode. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
| ARAdventureWorksOLAP.DimGeography.SetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
| ARAdventureWorksOLAP.DimGeography.GetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
| ARAdventureWorksOLAP.DimGeography.TryGetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd | ARCQuery | EnumMember | Example: '*ABC*'. |
| ARAdventureWorksOLAP.DimGeography.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| 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). |
| ARAdventureWorksOLAP.DimGeography.Storage | ARAdventureWorksOLAP | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
| ARAdventureWorksOLAP.DimOrganization | ARAdventureWorksOLAP | Class | Represents part of an organizational structure. See also -DimOrganizationP- and -DimOrganizationCollection-. |
| ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
| ARAdventureWorksOLAP.DimOrganization.SetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccountCollection.TryGetV | ARAdventureWorksOLAP | 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). |
| ARAdventureWorksOLAP.DimOrganization.GetPVDirect | ARAdventureWorksOLAP | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARAdventureWorksOLAP.DimAccountCollection.ToString | ARAdventureWorksOLAP | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
Generated 2026-02-28 23:46:55.227 UTC