[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() SKIP 832
235 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCAPI.AddController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.Quantile.SEXTILE | ARCQuery | EnumMember | Divide into 6 parts |
| ARCAPI.AddController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.Quantile.SEPTILE | ARCQuery | EnumMember | Divide into 7 parts |
| ARCAPI.AddController.AllowFilter | ARCAPI | ClassMember | Describes what data is allowed to change through a list of -Subscription- instances. |
| ARCQuery.Quantile.OCTILE | ARCQuery | EnumMember | Divide into 8 parts |
| ARCAPI.BaseController | ARCAPI | Class | Contains basic functionality for serving API methods. |
| ARCQuery.Quantile.DECILE | ARCQuery | EnumMember | Divide into 10 parts |
| ARCAPI.BaseController.BuildControllerStorage | ARCAPI | ClassMember | Builds a collection of 'std' (standard) controller instances to use for serving API requests. |
| ARCQuery.Quantile.DUODECILE | ARCQuery | EnumMember | Divide into 12 parts |
| ARCAPI.BaseController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.Quantile.HEXADECILE | ARCQuery | EnumMember | Divide into 16 parts |
| ARCAPI.BaseController.CatchAll | ARCAPI | ClassMember | Serves the typical single generic API method in an AgoRapide API. |
| ARCQuery.Quantile.VENTILE | ARCQuery | EnumMember | Divide into 20 parts |
| ARCAPI.BaseController.TryNavigateToLevelInDataStorage | ARCAPI | ClassMember | Navigates to the specified level (usually within -Storage-). |
| ARCQuery.Quantile.PERCENTILE | ARCQuery | EnumMember | Divide into 100 parts |
| ARCAPI.BaseController.GetFormatAndAdjustRequest | ARCAPI | ClassMember | Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on). |
| ARCQuery.Quantile.PERMILLE | ARCQuery | EnumMember | Divide into 1000 parts |
| ARCAPI.BaseController.GetTimestampIsOldWarningHTML | ARCAPI | ClassMember | If -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format. |
| ARCQuery.QueryProgressP | ARCQuery | Enum | Describes class -QueryProgress-. |
| ARCAPI.BaseController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
| ARCAPI.EditController | ARCAPI | Class | Offers a simple HTML editing environment of the raw -PropertyStream- from the given key. |
| ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
| ARCAPI.EditController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
| ARCAPI.EditController.ToString | ARCAPI | 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. |
| ARCAPI.GQController | ARCAPI | Class | Offers GraphQL queries. |
| ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
| ARCAPI.GQController.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.GQController.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.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
| ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
| ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
| ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
| ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
| ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
| ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
| 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.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
| ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
| ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
| ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
| 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. |
| AgoMail.EmailP.TextBody | AgoMail | EnumMember | |
| ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
| AgoMail.EmailP.HTMLBody | AgoMail | EnumMember | |
| ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
| AgoMail.EmailP.Headers | AgoMail | EnumMember | |
| ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
| AgoMail.EmailP.Attachments | AgoMail | EnumMember | |
| ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
| Namespace ARCCore | Namespace | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
| ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
| Namespace ARCDoc | Namespace | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
| Namespace ARCQuery | Namespace | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
| ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
| Namespace ARCAPI | Namespace | A library providing an API on top of the -PropertyStream-. | |
| ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
| Namespace AgoMail | Namespace | ||
| ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember | |
| Namespace AgoMail.Controllers | Namespace | ||
| ARCAPI.ResponseFormat.HTML | ARCAPI | EnumMember | |
| Assembly AgoMail | Assembly | ||
| AgoMail.Cleaner | AgoMail | Class | |
| AgoMail.Cleaner.Clean | AgoMail | ClassMember | Removes emails with often seen values for Subject, To or From. |
| AgoMail.Email | AgoMail | Class | |
| AgoMail.Email.TryGetV | AgoMail | 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). |
| AgoMail.Email.ToString | AgoMail | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| AgoMail.Program | AgoMail | Class | Application startup and initialization |
| AgoMail.Program.InitStreamProcessor | AgoMail | ClassMember | Initializes stream processor. |
| AgoMail.Root | AgoMail | Class | Contains the user friendly welcome text (front page) for the application. |
| AgoMail.Root.ToHTMLSimpleSingle | AgoMail | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| AgoMail.Root.TryGetV | AgoMail | 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). |
| AgoMail.Root.ToString | AgoMail | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| AgoMail.Controllers.ControllerFacade | AgoMail | Class | Facade for entry into the desired -BaseController-. |
| AgoMail.Controllers.ControllerFacade.CatchAll Overload2 | AgoMail | ClassMember | Catches all HTTP GET requests to this API. |
| AgoMail.Controllers.ControllerFacade.CatchAll Overload1 | AgoMail | ClassMember | Catches all HTTP POST requests to this API. |
| AgoMail.EmailP | AgoMail | Enum | |
| AgoMail.EmailP.Date | AgoMail | EnumMember | UTC-format |
| AgoMail.EmailP.From | AgoMail | EnumMember | |
| AgoMail.EmailP.To | AgoMail | EnumMember | |
| AgoMail.EmailP.CC | AgoMail | EnumMember | |
| AgoMail.EmailP.Subject | AgoMail | EnumMember | |
| ARCQuery.NewKeyCountP.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.NewKeyCountP.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.NewKeyCountP.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.NewKeyCountP.SyntaxHelp | ARCQuery | ClassMember | 'CountP()' |
| ARCQuery.NewKeyCountP.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.NewKeyCountP.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.NewKeyCountPRec | ARCQuery | Class | Returns the number of properties for a given entity object. |
| ARCQuery.NewKeyCountPRec.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| ARCQuery.NewKeyCountPRec.CountPRec | ARCQuery | ClassMember | Counts recursively the number of properties for a given entity object. |
| ARCQuery.NewKeyCountPRec.ToString | ARCQuery | ClassMember | The ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'. |
| ARCQuery.NewKeyCountPRec.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.NewKeyCountPRec.SyntaxHelp | ARCQuery | ClassMember | 'CountPRec()' |
| ARCQuery.NewKeyCountPRec.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.NewKeyCountPRec.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.NewKeyGetType | ARCQuery | Class | Returns the internal C# object type of the given object. |
| ARCQuery.NewKeyGetType.TryGetPInternal | ARCQuery | ClassMember | The internal executor, containing the specific functionality for how to evaluate the key. |
| 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.NewKeyToPropertyStream.TryGetP | ARCQuery | ClassMember | The outwards facing executor, understanding use of -FunctionKeys-. |
| ARCQuery.NewKeyToPropertyStream.SyntaxHelp | ARCQuery | ClassMember | 'ToPropertyStream()' |
| ARCQuery.NewKeyToPropertyStream.FunctionKeys | ARCQuery | ClassMember | All -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-). |
| ARCQuery.NewKeyToPropertyStream.QuantileKey | ARCQuery | ClassMember | Eventual final -QuantileKey- at end of compound key. |
| ARCQuery.QuantileKey | ARCQuery | Class | Can separate entities into quantiles, like Quartiles, Quintiles or Sextiles. |
| ARCQuery.QuantileKey.TryGetP | ARCQuery | ClassMember | Returns an integer with the number of the quantile group for the value returned by the given -CompoundKey-). |
| ARCQuery.QuantileKey.TryParse | ARCQuery | ClassMember | Note that any value (positive integer greated than 2) is accepted, not necessarily only string-representations of enums within -Quantile-. |
| ARCQuery.Query | ARCQuery | Class | Keeps track of progress of query, and the interim result. |
| 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.QueryExpression.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpression.Parsers | ARCQuery | ClassMember | Parsers for all the relevant sub classes of -QueryExpression-. |
| ARCQuery.QueryExpressionWithSuggestions | ARCQuery | Class | Keeps track as each query item gets executed. |
| ARCQuery.QueryExpressionWithSuggestions.Previous | ARCQuery | ClassMember | Suggestion for a 'browse backwards' button. |
| ARCQuery.QueryExpressionWithSuggestions.Next | ARCQuery | ClassMember | Suggestion for a 'browse forwards' button. |
| ARCQuery.QueryExpressionAggregate | ARCQuery | Class | Aggregates over the given key. |
| ARCQuery.QueryExpressionAggregate.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionAggregate.IsSuitableAggregator | ARCQuery | ClassMember | Returns true if |
| ARCQuery.QueryExpressionAggregate.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionAggregate.SyntaxHelp | ARCQuery | ClassMember | 1) 'AGGREGATE {rowKey}' like "AGGREGATE Product" |
| ARCQuery.QueryExpressionAggregate.AggregationType | ARCQuery | ClassMember | Most common value is -Count-, in which case -AggregationKey- may be correspondingly set to null. |
| ARCQuery.QueryExpressionAggregate.AggregationKey | ARCQuery | ClassMember | This is often null (with -AggregationType- correspondingly set to Count-). |
| ARCQuery.QueryExpressionAll | ARCQuery | Class | Represents all entities for a given collection. |
| ARCQuery.QueryExpressionAll.Execute | ARCQuery | ClassMember | Transforms the given input collection into a resulting collection. |
| ARCQuery.QueryExpressionAll.TryCheckForExistenceOfKey | ARCQuery | ClassMember | Used by query expressions in order to catch wrong field names used or misspelling of field names. |
| ARCQuery.QueryExpressionAll.SyntaxHelp | ARCQuery | ClassMember | 'ALL' (literally). |
| ARCCore.ActualConnectionP.Id | ARCCore | EnumMember | When connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection. |
| ARCCore.ActualConnectionP.ConnectionInstruction | ARCCore | EnumMember | Only relevant when we are an -Outgoing-. |
| ARCCore.ActualConnectionP.ConnectionDirection | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.CountReceiveMessage | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.CountSendMessage | ARCCore | EnumMember | |
| ARCCore.ActualConnectionP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCCore.ActualConnectionP.SubscriptionAsRequestedByClient | ARCCore | EnumMember | Originates from -Subscription-. |
| ARCCore.ActualConnectionP.ClosingReason | ARCCore | EnumMember | Reason why this connection was closed |
| ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
| ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
| ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
| ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
| ARCCore.StreamProcessorP.IndividualStorageFileSize | ARCCore | EnumMember | Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-. |
| ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
| ARCCore.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
| ARCCore.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCCore.StreamProcessorP.DoNotStoreLocally | ARCCore | EnumMember | For -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-. |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| 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.DocLink.AHrefEndPart | ARCDoc | ClassMember | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
| ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
| ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
| ARCDoc.DocLinkCollection.InsertLinks | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
| ARCDoc.DocLinkCollection.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.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
| ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
| ARCDoc.DocLinkResolution.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.DocLinkResolution.ToString | ARCDoc | 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.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.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. |
| ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
| ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
| ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
| ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
| ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
| ARCDoc.BananaP.Name | ARCDoc | EnumMember | The name of the banana |
| ARCDoc.BananaP.Colour | ARCDoc | EnumMember | |
| ARCDoc.OrangeP | ARCDoc | Enum | Describes class -Orange-. |
| ARCDoc.OrangeP.Name | ARCDoc | EnumMember | The name of the orange |
| ARCDoc.OrangeP.Colour | ARCDoc | EnumMember | |
| ARCDoc.SomeAppComponentP | ARCDoc | Enum | Describes class -SomeAppComponent-. |
| ARCDoc.SomeAppComponentP.SomeCountValue | ARCDoc | EnumMember | |
| ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged | ARCDoc | EnumMember | |
| ARCDoc.DocFragP | ARCDoc | Enum | Describes class -DocFrag-. |
| ARCDoc.DocFragP.DocFragType | ARCDoc | EnumMember | |
| ARCDoc.DocFragP.Assembly | ARCDoc | EnumMember | Name of the assembly in which this fragment resides. |
| ARCDoc.DocFragP.Namespace | ARCDoc | EnumMember | Namespace in which this fragment resides. |
| ARCDoc.DocFragP.ParentNamespace | ARCDoc | EnumMember | Parent namespace of namespace in which this fragment resides. |
| ARCDoc.DocFragP.Type | ARCDoc | EnumMember | Type of class or enum which this fragment describes (also relevant for class or enum member). |
| ARCDoc.DocFragP.Name | ARCDoc | EnumMember | As simple a name as practical usable. Often not unique within a greater context. |
| ARCDoc.DocFragP.IsInherited | ARCDoc | EnumMember | Relevant for class members. TRUE if method is inherited from a base type. |
Generated 2025-11-06 02:04:57.722 UTC