[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 1035 > < TAKE 224 >
142 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCQuery.FunctionKeyFirstLine | ARCQuery | Class | Extracts first line from string of text. |
| ARCQuery.FunctionKeyFirstLine.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyFirstLine.SyntaxHelp | ARCQuery | ClassMember | 'FirstLine()' |
| ARCQuery.FunctionKeyVeryShort | ARCQuery | Class | Returns the -ToStringVeryShort- representation of the given type. |
| ARCQuery.FunctionKeyVeryShort.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyVeryShort.SyntaxHelp | ARCQuery | ClassMember | 'VeryShort()' |
| ARCQuery.FunctionKeyHourMinute | ARCQuery | Class | Formats a timespan with only the hour and minute part. Uses format hh:mm. |
| ARCQuery.FunctionKeyHourMinute.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyHourMinute.SyntaxHelp | ARCQuery | ClassMember | 'HourMinute()' |
| ARCQuery.FunctionKeyInt | ARCQuery | Class | Rounds a double value to the nearest integer (uses .NET data type Int64 (long)). |
| ARCQuery.FunctionKeyInt.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| ARCQuery.FunctionKeyInt.SyntaxHelp | ARCQuery | ClassMember | 'Int()' |
| ARCQuery.FunctionKeyLength | ARCQuery | Class | Returns length of (string) value of field, like 4 for 'John'. |
| ARCQuery.FunctionKeyLength.TryGetP | ARCQuery | ClassMember | NOTE: The in-parameter is a property, not an entity. |
| 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.QueryExpressionPivot.GetCrossSummationChecker | ARCQuery | ClassMember | Returns a cross sum checker for int, long, double, Timespan. |
| ARCQuery.QueryExpressionPivot.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionPivot.SyntaxHelp | ARCQuery | ClassMember | 1) 'PIVOT {rowKey} BY {columnKey}' like "PIVOT Colour BY Production.Year" |
| ARCQuery.QueryExpressionPivot.AggregationType | ARCQuery | ClassMember | Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null. |
| ARCQuery.QueryExpressionPivot.AggregationKey | ARCQuery | ClassMember | This is often null (with -AggregationType- correspondingly set to Count-). |
| ARCQuery.QueryExpressionRel | ARCQuery | Class | Enables 'jumping' or 'travelling' from a collection of one entity type to another (related) entity type. |
| ARCQuery.QueryExpressionRel.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionRel.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| 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 | |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter | ARCQuery | EnumMember | |
| ARCQuery.QueryProgressP.Title | ARCQuery | EnumMember | The title to be used in the final presentation of the query result. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Year | ARCQuery | EnumMember | |
| ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
| Assembly ARCAPI | Assembly | A library providing an API on top of the -PropertyStream-. | |
| ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
| ARCAPI.ContentResult | ARCAPI | Class | Mimicks Microsoft.AspNetCore.Mvc.ContentResult. |
| ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
| ARCAPI.ContentResult.CreateHTMLOK | ARCAPI | ClassMember | NOTE: Parameter must be a complete HTML page. |
| ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
| ARCAPI.ContentResult.CreateError | ARCAPI | ClassMember | TODO: Add a key / value format for error messages, like done for -Log-. |
| ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
| ARCAPI.AddController | ARCAPI | Class | Parses and stores a -PropertyStreamLine-. |
| ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
| ARCAPI.AddController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| 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. |
| 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. |
| ARCAPI.AddController.AllowFilter | ARCAPI | ClassMember | Describes what data is allowed to change through a list of -Subscription- instances. |
| ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
| ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
| ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
| ARCAPI.BaseController.BuildControllerStorage | ARCAPI | ClassMember | Builds a collection of 'std' (standard) controller instances to use for serving API requests. |
| ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
| ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
| ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
| 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. |
| ARCAPI.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
| ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
| ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
| ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
| ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
| ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
| ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
| ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
| ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
| ARCAPI.EditController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd | ARCQuery | EnumMember | Example: '*ABC*'. |
| ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
| 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.GQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
| ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
| 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-. |
| 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 | ||
| ARCQuery.UtilQuery.SplitOutsideOf | ARCQuery | ClassMember | Equivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators. |
| ARCQuery.UtilQuery.SpecialLinkPrefixes | ARCQuery | ClassMember | Contains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix. |
| ARCQuery.ValueComparer | ARCQuery | Class | Can evaluation expressions like 'WHERE Created = ThisYear. |
| ARCQuery.ValueComparer.TryGetPrevious | ARCQuery | ClassMember | Suggestion for previous query (browsing 'backwards') |
| ARCQuery.ValueComparer.TryGetNext | ARCQuery | ClassMember | Suggestion for next query (browsing 'forwards') |
| ARCQuery.ValueComparerDateTime | ARCQuery | Class | -ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries. |
| ARCQuery.ValueComparerDateTime.TryGetPrevious | ARCQuery | ClassMember | Suggestion for previous query (browsing 'backwards') |
| ARCQuery.ValueComparerDateTime.TryGetNext | ARCQuery | ClassMember | Suggestion for next query (browsing 'forwards') |
| ARCQuery.ValueComparerDateTime.TryParse | ARCQuery | ClassMember | Note: This parser is probably exhaustive but not necessarily logical |
| ARCQuery.ValueComparerDateTime.Resolution | ARCQuery | ClassMember | See -ResolutionEnum-. |
| ARCQuery.ValueComparerDateTime.Steps | ARCQuery | ClassMember | Value 0 would mean 'This', like ThisHour, Today, ThisMonth and so on. |
| ARCQuery.ValueComparerDateTime.IsGliding | ARCQuery | ClassMember | The modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance |
| ARCQuery.ValueComparerDateTime.IsBefore | ARCQuery | ClassMember | The modifier 'Before' can be prepended in order to mean from any time before the specified time. |
| ARCQuery.ValueComparerDateTime.IsAfter | ARCQuery | ClassMember | The modifier 'After' can be prepended in order to mean any time after the specified time. |
| ARCQuery.ValueComparerDateTime.IsInterval | ARCQuery | ClassMember | Normally the interval which is compared against is the timespan corresponding to -Resolution-. |
| ARCQuery.ValueComparerDateTime.InitValue | ARCQuery | ClassMember | For debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-. |
| ARCQuery.ValueComparerDateTime.StartPeriod | ARCQuery | ClassMember | The start of the interval which this instance compares against. |
| ARCQuery.ValueComparerDateTime.EndPeriod | ARCQuery | ClassMember | The end of the interval which this instance compares against. |
| ARCQuery.ValueComparerDateTime.ToDebugProperties | ARCQuery | ClassMember | Exposes all members of this class. |
| ARCQuery.ForeignKey+IKIPEqualityComparer | ARCQuery | Class | Used by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys |
| ARCQuery.ForeignKey+EntityTypeAndKey | ARCQuery | Class | Describes an entity type and a key. |
| ARCQuery.ForeignKey+EntityTypeAndKey.EntityType | ARCQuery | ClassMember | For -IPRelationsKeysPointingTo-, corresponds to foreign entity type. |
| ARCQuery.ForeignKey+EntityTypeAndKey.Key | ARCQuery | ClassMember | NOTE: Key in EntityTypeAndKey was relaxed from PK to IK 25 Feb 2022 in order for experiment in -ForeignKey- to work. |
| ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTerm | ARCQuery | ClassMember | Corresponds to -PKRelAttributeP-.- OppositeTerm-. |
Generated 2025-08-09 06:55:08.256 UTC