[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1011 > < TAKE 384 >
166 items
DocFragId | Assembly | DocFragType | Description.FirstLine() |
---|---|---|---|
Assembly ARCAPI | Assembly | A library providing an API on top of the -PropertyStream-. | |
ARCAPI.ContentResult | ARCAPI | Class | Mimicks Microsoft.AspNetCore.Mvc.ContentResult. |
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.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-. |
ARCQuery.Strictness.OFF | ARCQuery | EnumMember | |
ARCQuery.Quantile | ARCQuery | Enum | Describes quantiles like -TERTILE- and -QUARTILE-. |
ARCQuery.Quantile.MEDIAN | ARCQuery | EnumMember | Divide into two parts |
ARCQuery.Quantile.TERTILE | ARCQuery | EnumMember | Divide into three parts |
ARCQuery.Quantile.QUARTILE | ARCQuery | EnumMember | Divide into four parts |
ARCQuery.Quantile.QUINTILE | ARCQuery | EnumMember | Divide into five parts |
ARCQuery.Quantile.SEXTILE | ARCQuery | EnumMember | Divide into 6 parts |
ARCQuery.Quantile.SEPTILE | ARCQuery | EnumMember | Divide into 7 parts |
ARCQuery.Quantile.OCTILE | ARCQuery | EnumMember | Divide into 8 parts |
ARCQuery.Quantile.DECILE | ARCQuery | EnumMember | Divide into 10 parts |
ARCQuery.Quantile.DUODECILE | ARCQuery | EnumMember | Divide into 12 parts |
ARCQuery.Quantile.HEXADECILE | ARCQuery | EnumMember | Divide into 16 parts |
ARCQuery.Quantile.VENTILE | ARCQuery | EnumMember | Divide into 20 parts |
ARCQuery.Quantile.PERCENTILE | ARCQuery | EnumMember | Divide into 100 parts |
ARCQuery.Quantile.PERMILLE | ARCQuery | EnumMember | Divide into 1000 parts |
ARCQuery.QueryProgressP | ARCQuery | Enum | Describes class -QueryProgress-. |
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. |
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 | |
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 | ||
ARCDoc.DocLinkP | ARCDoc | Enum | Describes class -DocLink-. |
ARCDoc.DocLinkP.Location | ARCDoc | EnumMember | The location that this link points to. |
ARCDoc.DocLinkP.Filename | ARCDoc | EnumMember | |
ARCDoc.DocLinkP.LinkWordHTML | ARCDoc | EnumMember | Actual link as it is expected to occur in text, like '-MyCustomerClass<T>-'. |
ARCDoc.DocLinkResolutionP | ARCDoc | Enum | Describes class -DocLinkResolution- |
ARCDoc.DocLinkResolutionP.LinkWord | ARCDoc | EnumMember | |
ARCDoc.DocLinkResolutionP.DocLinks | ARCDoc | EnumMember | The possible links for -LinkWord- |
ARCDoc.DocumentatorP | ARCDoc | Enum | Describes class -Documentator-. |
ARCQuery.BinaryOperatorKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
ARCQuery.BinaryOperatorKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.CompoundInvalidKey | ARCQuery | Class | Used as a practical solution in order to know that a given key has been attemped parsed, but was not valid. |
ARCQuery.CompoundInvalidKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
ARCQuery.CompoundInvalidKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
ARCQuery.CompoundInvalidKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
ARCQuery.CompoundInvalidKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
ARCQuery.CompoundInvalidKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.CompoundKey | ARCQuery | Class | A class able to expand the concept of entity keys. |
ARCQuery.CompoundKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
ARCQuery.CompoundKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
ARCQuery.CompoundKey.Parse | ARCQuery | ClassMember | Note that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails'). |
ARCQuery.CompoundKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
ARCQuery.CompoundKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
ARCQuery.CompoundKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.ConstantKey<T> | ARCQuery | Class | Represents a constant expression like "' '", "', '", "42". |
ARCQuery.EntityMethodKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.ForeignKey | ARCQuery | Class | Can find related values, through compound field names. |
ARCQuery.ForeignKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
ARCQuery.ForeignKey.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
ARCQuery.ForeignKey.AllForeignKeysForEntityType | ARCQuery | ClassMember | Returns all possible foreign keys relevant for the given entity type, like for Order: 'Customer.FirstName' and 'Customer.LastName'. |
ARCQuery.ForeignKey.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
ARCQuery.ForeignKey.Steps | ARCQuery | ClassMember | The actual -ForeignKeySingleStep- leading to the -ForeignField-. |
ARCQuery.ForeignKey.StepsAreOnlyDirectionToOne | ARCQuery | ClassMember | If TRUE then -TryGetPInternal) will use much simpler code without collections and parallell executions. |
ARCQuery.ForeignKey.ForeignField | ARCQuery | ClassMember | The actual field in the final foreign entity to return value for. |
ARCQuery.ForeignKey.AggregateKeys | ARCQuery | ClassMember | Aggregations to be used on the multiple foreign entity values that are found when one of the -Steps- are -ToMany-. |
ARCQuery.ForeignKey.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
ARCQuery.ForeignKey.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
ARCQuery.ForeignKey.IPRelationsKeysPointingTo | ARCQuery | ClassMember | Contains, for each (entity type) key, a list of entity types with foreign keys pointing to that entity type. |
ARCQuery.ForeignKey.IPRelationsKeysPointingFrom | ARCQuery | ClassMember | Contains, for each (entity type) key, a list of entity types which that entity type points to. |
ARCQuery.MemberEntityKey | ARCQuery | Class | Can find value for entity which is member of entity being queried. |
ARCQuery.MemberEntityKey.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
ARCQuery.FunctionKeyAggregateAvg.SyntaxHelp | ARCQuery | ClassMember | 'Avg()' |
ARCQuery.FunctionKeyAggregateCount | ARCQuery | Class | Counts the number of properties found. |
ARCQuery.FunctionKeyAggregateCount.SyntaxHelp | ARCQuery | ClassMember | 'Count()' |
ARCQuery.FunctionKeyAggregateDistinct | ARCQuery | Class | Returns a list of the distinct values of the given properties. |
ARCQuery.FunctionKeyAggregateDistinct.SyntaxHelp | ARCQuery | ClassMember | 'Distinct()' |
ARCQuery.FunctionKeyAggregateJoin | ARCQuery | Class | Joins the given list of properties into a single property. |
ARCQuery.FunctionKeyAggregateJoin.SyntaxHelp | ARCQuery | ClassMember | 'Join()' |
ARCQuery.FunctionKeyAggregateMax | ARCQuery | Class | Calculates the maximum value of the given properties. |
ARCQuery.FunctionKeyAggregateMax.SyntaxHelp | ARCQuery | ClassMember | 'Max()' |
ARCQuery.FunctionKeyAggregateMin | ARCQuery | Class | Calculates the minimum value of the given properties. |
ARCQuery.FunctionKeyAggregateMin.SyntaxHelp | ARCQuery | ClassMember | 'Min()' |
ARCQuery.FunctionKeyAggregateSingle | ARCQuery | Class | Ensures that the given list of properties contains only a single item and returns that item. |
ARCQuery.FunctionKeyAggregateSingle.SyntaxHelp | ARCQuery | ClassMember | 'Single()' |
ARCQuery.FunctionKeyAggregateSum | ARCQuery | Class | Sums the given properties. |
ARCQuery.FunctionKeyAggregateSum.SyntaxHelp | ARCQuery | ClassMember | 'Sum()' |
ARCQuery.FunctionKey | ARCQuery | Class | Extracts data from an already existing value like extracting Year from a DateTime in 'Created.Year()'. |
ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.Apple.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.Apple.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.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
ARCDoc.Orange.TryGetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
ARCDoc.Orange.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
ARCDoc.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
ARCDoc.DocFrag.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.DocFrag.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.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
Generated 2025-06-22 22:30:00.408 UTC