[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 924 > < TAKE 512 >
253 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
| ARCCore.PP.ExceptionText | ARCCore | EnumMember | General property for logging of exceptions, usually set through -HandleException-. |
| ARCAPI.GQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ActualConnectionP.PartnerIPAddress | ARCCore | EnumMember | TODO: Use more strongly typing for this. |
| 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. |
| ARCCore.StreamProcessorP.CurrentlyInitializing | ARCCore | EnumMember | Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them). |
| AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2 | AgoBrowse | ClassMember | Catches all HTTP GET requests to this API. |
| ARCCore.ConnectionInstructionP | ARCCore | Enum | Describes class -ConnectionInstruction-. |
| ARCQuery.QueryExpressionWhere+ValueEnum.ALL | ARCQuery | EnumMember | Equivalent to query like WHERE Name = * |
| ARCCore.StreamProcessorP.ClientUpdatePositionPath | ARCCore | EnumMember | Complete path to file containing -ClientUpdatePosition-. |
| AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1 | AgoBrowse | ClassMember | Catches all HTTP POST requests to this API. |
| ARCCore.ConnectionInstructionP.ClientId | ARCCore | EnumMember | The AgoRapide node-id for which this connection is relevant. Used for distributing over the -PropertyStream- information to the clients about which possible nodes they can connect to. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum | ARCQuery | Enum | |
| ARCCore.StreamProcessorP.ClientUpdatePosition | ARCCore | EnumMember | Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side). |
| Namespace ARCCore | Namespace | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
| ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Second | ARCQuery | EnumMember | |
| ARCCore.StreamProcessorP.IncomingConnectionsPortNo | ARCCore | EnumMember | If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-). |
| Namespace ARCDoc | Namespace | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute | ARCQuery | EnumMember | |
| ARCCore.StreamProcessorP.UnderClosure | ARCCore | EnumMember | Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope |
| Namespace ARCQuery | Namespace | ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs. | |
| ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour | ARCQuery | EnumMember | |
| ARCCore.StreamProcessorP.WriteToConsole | ARCCore | EnumMember | If true then incoming data (from other nodes will be written to console. |
| Namespace ARCAPI | Namespace | A library providing an API on top of the -PropertyStream-. | |
| ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Day | ARCQuery | EnumMember | |
| ARCCore.StreamProcessorP.Timestamp | ARCCore | EnumMember | The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-. |
| Namespace AgoBrowse | Namespace | ||
| ARCCore.ConnectionInstructionP.Subscription | ARCCore | EnumMember | The actual subscripton. This is what the connecting party / (downstream) client would send over its TCP/IP connection to the (upstream) server. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Week | ARCQuery | EnumMember | |
| ARCCore.StreamProcessorP.TimestampIsOld | ARCCore | EnumMember | A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date. |
| Namespace AgoBrowse.Controllers | Namespace | ||
| ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Month | ARCQuery | EnumMember | |
| ARCCore.StreamProcessorP.TimestampResolution | ARCCore | EnumMember | The time interval between each timestamp update in the -PropertyStream-. |
| ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter | ARCQuery | EnumMember | |
| 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.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Year | ARCQuery | EnumMember | |
| ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocally | ARCCore | EnumMember | Means 'do not store local origin locally but wait until it gets confirmed by core storage'. |
| ARCCore.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
| Assembly ARCAPI | Assembly | A library providing an API on top of the -PropertyStream-. | |
| ARCCore.StreamProcessorP.CacheDiskWrites | ARCCore | EnumMember | If TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance. |
| ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
| ARCAPI.ContentResult | ARCAPI | Class | Mimicks Microsoft.AspNetCore.Mvc.ContentResult. |
| ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
| ARCCore.MultipleConnectionUsage.Simultaneous | ARCCore | EnumMember | This connection to be used simultaneously with other connections with -Simultaneous- |
| ARCAPI.ContentResult.CreateHTMLOK | ARCAPI | ClassMember | NOTE: Parameter must be a complete HTML page. |
| ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
| ARCCore.StreamProcessorP | ARCCore | Enum | Describes class -StreamProcessor-. |
| ARCAPI.ContentResult.CreateError | ARCAPI | ClassMember | TODO: Add a key / value format for error messages, like done for -Log-. |
| ARCCore.StreamProcessorP.CountOutgoingConnections | ARCCore | EnumMember | |
| ARCCore.StreamProcessorP.LocalStorageFolder | ARCCore | EnumMember | The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar |
| ARCAPI.AddController | ARCAPI | Class | Parses and stores a -PropertyStreamLine-. |
| ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
| 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-. |
| ARCAPI.AddController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCDoc.Demonstrator.DemonstrateLogConsole | ARCDoc | ClassMember | Demonstrates a quite simple log console. |
| ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
| ARCAPI.RQController | ARCAPI | Class | RQ = REST Query. Executes a REST like query request against the given -DataStorage-. |
| ARCDoc.Demonstrator.DemonstrateStreamProcessorAsClient | ARCDoc | ClassMember | Demonstrates use of -StreamProcessor- as a general client. |
| ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
| ARCAPI.RQController.APIMethod | ARCAPI | ClassMember | The (only) API method that this controller supports. |
| ARCDoc.Orange | ARCDoc | Class | Inherits -PExact- for probably the best compromise between memory consumption and easy of development. |
| ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
| ARCAPI.RQController.ToString | ARCAPI | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Orange.SetPVDirect | ARCDoc | ClassMember | High performance alternative to -TrySetP-, accessing -Storage- more direct. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| ARCAPI.DataStorage | ARCAPI | Class | The all-in-memory global application data storage. |
| ARCDoc.Orange.GetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCCore.StorageFileP.Hash | ARCCore | EnumMember | Hash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line |
| ARCAPI.DataStorage.Create | ARCAPI | ClassMember | Creates a -DataStorage- instance with default parameters. |
| ARCDoc.Orange.TryGetPVDirect | ARCDoc | ClassMember | High performance alternative to -TryGetP-, accessing -Storage- more direct. |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCAPI.DataStorage..ctor | ARCAPI | ClassMember | This method will: |
| ARCDoc.Orange.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCAPI.DataStorage.Storage | ARCAPI | ClassMember | The actual storage. |
| ARCDoc.Orange.Name | ARCDoc | ClassMember | See -Name- for more information. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCAPI.DataStorage.ControllerStorage | ARCAPI | ClassMember | Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]). |
| ARCDoc.Orange.Storage | ARCDoc | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCAPI.DataStorage.DocLinks | ARCAPI | ClassMember | Note that may be null. |
| ARCDoc.SomeAppComponent | ARCDoc | Class | Demonstrates how also your actual application classes, not only your data classes, should implement -IP-. |
| ARCCore.DataTransferDirection.Send | ARCCore | EnumMember | Like -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-. |
| ARCAPI.DataStorage.Lock | ARCAPI | ClassMember | Locking object for thread-safe access from simultaneous API requests. |
| ARCDoc.SomeAppComponent.MethodC | ARCDoc | ClassMember | Note structured format in logging. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCAPI.DataStorage.ExternalReceiver | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCDoc.SomeAppComponent.MethodD | ARCDoc | ClassMember | Same as MethodC- but returns data ('Func<string>()' instead of 'Action()') |
| ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
| ARCAPI.DataStorage.DoNotStoreInternally | ARCAPI | ClassMember | Typically used by -AddController-. |
| ARCDoc.SomeAppComponent.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCAPI.BaseControllerP | ARCAPI | Enum | Describes class -BaseController-. |
| ARCDoc.DocFrag | ARCDoc | Class | DocFrag = Document fragment. |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| ARCAPI.BaseControllerP.CountRequest | ARCAPI | EnumMember | Number of calls to -APIMethod- since application initialization |
| ARCDoc.DocFrag.Create Overload1 | ARCDoc | ClassMember | Creates a -DocFrag- object representing an assembly or a namespace. |
| ARCDoc.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCAPI.BaseControllerP.CountException | ARCAPI | EnumMember | Number of exceptions at call to -APIMethod- since application initialization |
| ARCDoc.DocFrag.Create Overload2 | ARCDoc | ClassMember | Creates a -DocFrag- object representing a class, class member, enum or enum member. |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCAPI.BaseControllerP.LogLevel | ARCAPI | EnumMember | |
| ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.Apple.TryGetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCAPI.ResponseFormat | ARCAPI | Enum | The response format, HTML or JSON, for an API request. |
| 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.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. |
| ARCAPI.ResponseFormat.JSON | ARCAPI | EnumMember | |
| 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.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). |
| ARCAPI.ResponseFormat.HTML | ARCAPI | EnumMember | |
| ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Apple.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| Assembly AgoBrowse | Assembly | ||
| ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
| ARCDoc.Apple.Name | ARCDoc | ClassMember | Convenience method, not obligatory. |
| AgoBrowse.Program | AgoBrowse | Class | |
| ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
| ARCDoc.Banana | ARCDoc | Class | Implements -IP- directly and uses traditional property storage for optimum -MemoryConsumption- efficiency. |
| AgoBrowse.Program.InitStreamProcessor | AgoBrowse | ClassMember | Initializes stream processor. |
| ARCDoc.DocFragCollection.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.Banana.Name | ARCDoc | ClassMember | Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc) |
| AgoBrowse.Root | AgoBrowse | Class | Contains the user friendly welcome text (front page) for the application. |
| ARCDoc.DocFragCollection.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.Banana.Colour | ARCDoc | ClassMember | Annotated as nullable in order to keep flexibility of -PropertyAccess-, including what happens if values are not set (TryGetP etc) |
| AgoBrowse.Root.ToHTMLSimpleSingle | AgoBrowse | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Demonstrator | ARCDoc | Class | Demonstrates various concepts from -ARCCore-, especially -PropertyAccess-. |
| 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. |
| ARCDoc.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
| ARCDoc.Demonstrator.DemonstratePropertyAccessApple | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Apple- class. |
| 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). |
| ARCDoc.DocLink.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.Demonstrator.DemonstratePropertyAccessOrange | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Orange- class. |
| AgoBrowse.Root.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLink.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.Demonstrator.DemonstratePropertyAccessBanana | ARCDoc | ClassMember | Demonstrates use of -PropertyAccess- through the -Banana- class. |
| AgoBrowse.Controllers.CompileController | AgoBrowse | Class | Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-. |
| ARCDoc.DocLink.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Demonstrator.DemonstrateITypeDescriber | ARCDoc | ClassMember | Demonstrates use of -ITypeDescriber- for describing single-property values. |
| AgoBrowse.Controllers.CompileController.APIMethod | AgoBrowse | ClassMember | The (only) API method that this controller supports. |
| ARCDoc.DocLink.Location | ARCDoc | ClassMember | Copy of -Location-. |
| ARCDoc.Demonstrator.DemonstratePRichHierarchicalStorage | ARCDoc | ClassMember | Demonstrates use of -PRich-, how it receives -PropertyStream--lines and builds up a strongly typed hierarchical object storage. |
| AgoBrowse.Controllers.CompileController.Compile | AgoBrowse | ClassMember | Compiles a hierarchical 'picture book' from the given parameter. |
| ARCDoc.DocLink.Filename | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.Demonstrator.DemonstratePropertyStream | ARCDoc | ClassMember | Demonstrates use of -PropertyStream- by generating local data (documentation data) and writing locally to console. |
| AgoBrowse.Controllers.CompileController.ToString | AgoBrowse | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLink.LinkWordHTML | ARCDoc | ClassMember | Copy of -LinkWordHTML-. |
| ARCDoc.Demonstrator.DemonstrateBareBonesClient | ARCDoc | ClassMember | Demonstrates adding -PropertyStream--lines to -CoreDB- without using ANY AgoRapide component, only standard TCP/IP functionality in .NET. |
| AgoBrowse.Controllers.ControllerFacade | AgoBrowse | Class | Facade for entry into the desired -RQController-. |
| 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.DocLink.LinkWordHTMLWithHyphens | ARCDoc | ClassMember | -LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended. |
| 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.DocLink.LinkWordHTMLBeforeLt | ARCDoc | ClassMember | If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'. |
| ARCDoc.DummyEnum.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphens | ARCDoc | ClassMember | -LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended. |
| ARCDoc.Extensions | ARCDoc | Class | Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML. |
| ARCDoc.DocLink.AHrefEndPart | ARCDoc | ClassMember | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
| ARCDoc.Extensions.ToHTMLSimpleSingleRecursive | ARCDoc | ClassMember | Calls -ToHTMLSimpleSingle- recursively. |
| ARCDoc.DocLinkCollection | ARCDoc | Class | Contains a collection of -DocLink- objects. |
| ARCDoc.Extensions.ToHTMLSimpleSingle | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter. |
| ARCDoc.DocLinkCollection.Create | ARCDoc | ClassMember | Notes all locations and their positions in the hierarchical directory structure. |
| ARCDoc.Extensions.ToHTMLSimpleSingleInternal | ARCDoc | ClassMember | Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-. |
| ARCDoc.DocLinkCollection.InsertLinks Overload1 | ARCDoc | ClassMember | Does -LinkInsertionInDocumentation- on the given HTML content. |
| 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.DocLinkCollection.InsertLinks Overload2 | ARCDoc | ClassMember | See overload with 'contentLocation' as parameter for documentation. |
| ARCDoc.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
| ARCDoc.DocLinkCollection.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.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
| 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.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
| ARCDoc.DocLinkCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Extensions.GetHelptextHTML | ARCDoc | ClassMember | Returns content of -Description- and -LongDescription-. |
| ARCDoc.DocLinkResolution | ARCDoc | Class | Contains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances). |
| ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
| ARCDoc.DocLinkResolution.ToHTMLSimpleSingle | ARCDoc | ClassMember | Gives a friendly description about possible targets for LinkWord-. |
| 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.DocLinkResolution.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.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.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.DocLinkResolution.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.DocLinkResolutionCollection | ARCDoc | Class | Contains a collection of -DocLinkResolution- objects. |
| ARCDoc.HLocationCollection | ARCDoc | Class | Contains a collection of -HLocation- 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.HLocationCollection.Create | ARCDoc | ClassMember | Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- 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.HLocationCollection.WriteAllContentHTMLToDisk | ARCDoc | ClassMember | Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-. |
| ARCDoc.DocLinkResolutionCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| 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.Documentator | ARCDoc | Class | General class for documenting AgoRapide and also your own -ApplicationSpecificCode-. |
| 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.Documentator.CreateAndInsert | ARCDoc | ClassMember | Creates an instance of -Documentator- with a natural hierarchical representation of documentation attributes found in the given assemblies. |
| ARCDoc.HLocationCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Documentator.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.HTOC | ARCDoc | Class | HTOC = Hierarchical table of contents. |
| ARCDoc.Documentator.CreateHTOCStandard | ARCDoc | ClassMember | Creates a 'standard' table of contents, structured by assembly and each assembly divided into 'Class' and 'Enum'. |
| ARCDoc.HTOC.Create | ARCDoc | ClassMember | Structures content hierarchically according to the criteria for each level. |
| ARCDoc.Documentator.CreateHTOCNamespace | ARCDoc | ClassMember | Creates a table of contents structured by namespace |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload2 | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.Documentator.CreateHTOCInheritance | ARCDoc | ClassMember | Creates a table of contents structured by inheritance (classes and interfaces only, not members). |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload1 | ARCDoc | ClassMember | Use this method in any class where a table-of-contents type of view is desireable |
| 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.HTOC.CreateInitialContent | ARCDoc | ClassMember | Helper method for creation of a -FilterBranch-. |
| 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.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.Documentator.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| 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.Documentator.DocLinks | ARCDoc | ClassMember | Set by -CreateAndInsert-. |
| ARCDoc.HTOC.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Documentator.DocLinkResolutionLocation | ARCDoc | ClassMember | Default position within the global storage context of doc link resolution pages. |
| ARCDoc.HTOC.HTOCContentThisLevelKey | ARCDoc | ClassMember | The key used for storing the actual content at this level. |
| ARCDoc.DummyEnum | ARCDoc | Class | TODO: Document better what this is for (and change name) |
| 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.UtilDoc.GlobalHeaderHTML | ARCDoc | ClassMember | Global header to be inserted at the top of every HTML page created by -GenerateHTMLPage-. |
| 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. |
| ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
| ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
| ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
| ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
| ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
| ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
| ARCDoc.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
Generated 2025-12-05 04:53:06.299 UTC