[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 98 > < TAKE 125 >
125 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.IKString.FromString | ARCCore | ClassMember | Note how uses instance cache if already exists there |
| ARCCore.IKLong.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
| 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. |
| ARCCore.IKString.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
| ARCCore.IKLong.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.ConnectionInstructionP.ServerHostName | ARCCore | EnumMember | The host (DNS or IP-address) for which to connect. |
| ARCCore.IKString.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.IKString | ARCCore | Class | Index key for any general id, like primary-key or sequence-number or similar. |
| ARCCore.ConnectionInstructionP.ServerPortNo | ARCCore | EnumMember | The port number for which to connect. |
| ARCCore.IKType | ARCCore | Class | Index key used when storing a collection of a given type, like 'Customer'. |
| ARCCore.IKString.FromCache | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.ConnectionInstructionP.ConnectionId | ARCCore | EnumMember | Usually a combination of -ClientId-, -ServerHostName- and -ServerPortNo-. |
| ARCCore.ParseResult.Result | ARCCore | ClassMember | Will be null if ErrorResponse is set. |
| ARCCore.IKType.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| ARCCore.ConnectionInstructionP.DataTransferDirection | ARCCore | EnumMember | |
| ARCCore.ParseResult.ErrorResponse | ARCCore | ClassMember | Will be null if Result is set |
| ARCCore.ITypeDescriber | ARCCore | Class | Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance). |
| 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. |
| ARCCore.PK | ARCCore | Class | PK = AgoRapide PropertyKey. |
| ARCCore.ITypeDescriber.GetSyntaxHelp | ARCCore | ClassMember | Enables explanation of syntax in different contexts from one source: |
| ARCCore.ConnectionInstructionP.MultipleConnectionUsage | ARCCore | EnumMember | |
| ARCCore.PK.TryGetEnum | ARCCore | ClassMember | Note that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key. |
| ARCCore.ParseResult | ARCCore | Class | NOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement. |
| ARCCore.ConnectionInstructionP.Sharding | ARCCore | EnumMember | |
| ARCCore.PK.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| ARCCore.PK.TryGetV | ARCCore | ClassMember | Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter). |
| ARCCore.MultipleConnectionUsage | ARCCore | Enum | Enables fault-tolerance by describing use of multiple connections |
| ARCCore.PK.TryValidateAndParse | ARCCore | ClassMember | Parses the value according to specifications for this property key. |
| ARCCore.PK.GetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails |
| ARCCore.MultipleConnectionUsage.Admin | ARCCore | EnumMember | Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make. |
| ARCCore.PK.TryCleanValidateAndParse | ARCCore | ClassMember | Cleans and parses the value according to specifications for this property key. |
| ARCCore.PK.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
| ARCCore.MultipleConnectionUsage.RoundRobin | ARCCore | EnumMember | This connection to be used in a turn based system, together with other connections with -RoundRobin-. |
| ARCCore.PK.PackParseResultForStorageInEntityObject | ARCCore | ClassMember | Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-. |
| ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality | ARCCore | ClassMember | Called from -Initialize- after _cleaner and _validatorAndParser have been set. |
| ARCCore.StreamProcessorP.CopyFileStructureFromCore | ARCCore | EnumMember | If TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-). |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload1 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.PK.PackObjectForStorageInEntityObject | ARCCore | ClassMember | See -PackParseResultForStorageInEntityObject- for documentation. |
| ARCCore.StreamProcessorP.CountIncomingConnections | ARCCore | EnumMember | |
| ARCCore.PK.GetAllPKForEntityType | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
| ARCCore.PK.FromEnum | ARCCore | ClassMember | Returns the corresponding -PK- instance from the given -PropertyKeyEnum-. |
| ARCCore.StreamProcessorP.CountOutgoingConnections | ARCCore | EnumMember | |
| ARCCore.PK.GetAllPKForEntityTypeString | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload3 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.StreamProcessorP.CountOutsideLocalReceiver | ARCCore | EnumMember | Count of calls to -OutsideLocalReceiver-. |
| ARCCore.PK.BuildFromStringCache | ARCCore | ClassMember | Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload2 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.StreamProcessorP.CountReceiveLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- with -HasLocalOrigin-. |
| ARCCore.PK..ctor | ARCCore | ClassMember | Constructor with 'object _enum' is necessary in order for ToString to work. |
| ARCCore.PK.GetTypeMapping | ARCCore | ClassMember | Returns the relevant property key for a given type entity-type and field-type. |
| ARCCore.StreamProcessorP.CountReceiveNonLocalOrigin | ARCCore | EnumMember | Count of -PropertyStreamLine- not with -HasLocalOrigin-. |
| ARCCore.PK.Type | ARCCore | ClassMember | Returns type from -PKTypeAttribute-'s -Type-. |
| ARCCore.PK.GetObligatoryValuesForEntityType | ARCCore | ClassMember | Returns all obligatory values (based on -IsObligatory-) |
| ARCCore.StorageFileP | ARCCore | Enum | Describes class -StorageFile-. |
| ARCCore.PK.Cardinality | ARCCore | ClassMember | Returns cardinality from -PKTypeAttribute-'s -Cardinality-. |
| ARCCore.PK.Equals | ARCCore | ClassMember | Note that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal. |
| ARCCore.StorageFileP.Filename | ARCCore | EnumMember | |
| ARCCore.PK.CorrespondingClass | ARCCore | ClassMember | Returns -CorrespondingClass- based on -__enum-. |
| ARCCore.PK.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| 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 |
| ARCCore.PK.__enum | ARCCore | ClassMember | This information is also found as EnumMember. |
| ARCCore.PK.ValidatorAndParser | ARCCore | ClassMember | Validates and parses a value. |
| ARCCore.ConnectionDirection | ARCCore | Enum | The concept of who took the initiative for the connections (who asked to open the TCP/IP session). |
| ARCCore.PKHTMLAttribute | ARCCore | Class | Contains pointer to HTML encoder for a property. |
| ARCCore.PK.Cleaner | ARCCore | ClassMember | Cleanup of values, to be used before value is attempted validated. |
| ARCCore.ConnectionDirection.Incoming | ARCCore | EnumMember | ConnectionInstruction will not be set for these. |
| ARCCore.PKHTMLAttribute.Encode | ARCCore | ClassMember | Encodes the given string to HTML format through the static method implemented in class -Encoder-. |
| ARCCore.PK.AllEnums | ARCCore | ClassMember | All enums for the whole application. |
| ARCCore.ConnectionDirection.Outgoing | ARCCore | EnumMember | There would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-: |
| ARCCore.PKHTMLAttribute.Initialize | ARCCore | 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. |
| ARCCore.PK.AllPKEnums | ARCCore | ClassMember | All -PropertyKeyEnum--tagged enums for the whole application. |
| ARCCore.DataTransferDirection | ARCCore | Enum | Direction for transfer of data. |
| ARCCore.PKLogAttribute.IsDefault | ARCCore | 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.) |
| ARCCore.PKHTMLAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| 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-. |
| ARCCore.PKRelAttribute | ARCCore | Class | Describes relationships between entities (between tables in RDBMS terms). |
| ARCCore.PKHTMLAttribute.Encoder | ARCCore | ClassMember | See -Encoder-. |
| ARCCore.DataTransferDirection.Receive | ARCCore | EnumMember | Like -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-. |
| ARCCore.PKRelAttribute.Initialize | ARCCore | 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. |
| ARCCore.PKHTMLAttribute.IsDefault | ARCCore | 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.) |
| ARCCore.TPropertyKeyEnum | ARCCore | Enum | Placeholder for any enum type suitable as generic type parameter for -PExact-. |
| ARCCore.PKRelAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.IHTMLEncoder | ARCCore | Class | Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML. |
| Assembly ARCDoc | Assembly | A library supporting documentation and demonstrating usage of AgoRapide. | |
| ARCCore.PKRelAttribute.ForeignEntity | ARCCore | ClassMember | See -ForeignEntity-. |
| ARCCore.PKLogAttribute | ARCCore | Class | Explains how logging of changes to a property should be done. |
| ARCDoc.Apple | ARCDoc | Class | The most 'standard' way of implementing an entity-class in AgoRapide, by just inheriting -PRich-. |
| ARCCore.PKRelAttribute.OppositeTerm | ARCCore | ClassMember | See -OppositeTerm-. |
| ARCCore.PKLogAttribute.Initialize | ARCCore | 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.Apple.AddName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.PKRelAttribute.EnforceReferentialIntegrity | ARCCore | ClassMember | See -EnforceReferentialIntegrity-. |
| ARCCore.PKLogAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCDoc.Apple.GetName | ARCDoc | ClassMember | Convenience method, not obligatory. |
| ARCCore.PKRelAttribute.IsDefault | ARCCore | 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.) |
| ARCCore.PKLogAttribute.DoNotLogAtAll | ARCCore | ClassMember | See -DoNotLogAtAll-. |
| ARCDoc.DocFrag.ToHTMLSimpleSingle | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCCore.PKTypeAttribute.IsObligatory | ARCCore | ClassMember | See -IsObligatory-. |
| ARCCore.PKTypeAttribute | ARCCore | Class | Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-. |
| 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. |
| ARCCore.PKTypeAttribute.IsDefault | ARCCore | 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.) |
| ARCCore.PKTypeAttribute.Initialize | ARCCore | 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.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). |
| ARCCore.IP | ARCCore | Class | IP = IProperty. |
| ARCCore.PKTypeAttribute.StandardValidatorAndParser | ARCCore | ClassMember | Returns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri. |
| ARCDoc.DocFrag.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IP.TryGetV Overload2 | ARCCore | ClassMember | The actual value of the property. Mostly relevant for single-value properties like -PValue-. |
| ARCCore.PKTypeAttribute.StandardCleaner | ARCCore | ClassMember | Returns a cleaner for well known types like bool |
| ARCDoc.DocFragCollection | ARCDoc | Class | Contains a collection of -DocFrag- objects. |
| ARCCore.IP.Inc | ARCCore | ClassMember | Increments given property key by 1. Sets to 1 if not found. Uses long, not integer. |
| ARCCore.PKTypeAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCDoc.DocFragCollection.Create | ARCDoc | ClassMember | Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies. |
| ARCCore.IP.Dec | ARCCore | ClassMember | Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer. |
| ARCCore.PKTypeAttribute.Type | ARCCore | ClassMember | See -Type-. |
| 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. |
| ARCCore.IP.Log | ARCCore | ClassMember | The 'final' overload of -Log- that is called by the other overloads. |
| ARCCore.PKTypeAttribute.Cardinality | ARCCore | ClassMember | See -Cardinality-. |
| 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). |
| ARCCore.IP.LogExecuteTime | ARCCore | ClassMember | Times the execution of the given function and logs details about elapsed time. |
| ARCCore.PKTypeAttribute.DefaultValue | ARCCore | ClassMember | See -DefaultValue-. |
| ARCDoc.DocFragCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IP.OnTrySetP | ARCCore | ClassMember | Event handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done). |
| ARCCore.IP.HandleException | ARCCore | ClassMember | Note that most relevant to use for -PConcurrent-. |
| ARCDoc.DocLink | ARCDoc | Class | Describes to where a single HTML link points. |
| ARCCore.IP.TryGetP | ARCCore | ClassMember | Gets a single property for this object |
| ARCCore.IP.TryParseDtr | ARCCore | ClassMember | Parses a PropertyStreamLine- beginning with -dtr-. |
Generated 2025-09-24 09:34:52.177 UTC