[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() SKIP 0 > < TAKE 124 >
124 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| Assembly ARCCore | Assembly | A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to. | |
| ARCCore.BaseAttribute.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.BaseAttribute.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.BasePKAttribute | ARCCore | Class | The class containing the actual attributes used for -TaggingOfPropertyKeys-. |
| ARCCore.BasePKAttribute.GetAttributes | ARCCore | ClassMember | Note that illegal to call for other than -PropertyKeyEnum-. |
| ARCCore.BasePKAttribute.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.BasePKAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.BasePKAttribute.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.ClassAttribute.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.ClassAttribute.TryGetAsTypeScript | ARCCore | ClassMember | Generates typescript code corresponding to the class which this instance describes. |
| ARCCore.ClassAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.ClassAttribute.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.ClassMemberAttribute | ARCCore | Class | Describes a member of a class (a method). |
| ARCCore.ClassMemberAttribute.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.EnumAttribute | ARCCore | Class | Describes an enum. |
| ARCCore.EnumAttribute.TryGetAsTypeScript | ARCCore | ClassMember | Generates typescript code corresponding to the enum which this instance describes. |
| ARCCore.EnumAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.EnumMemberAttribute | ARCCore | Class | Describes an enum's value. |
| ARCCore.EnumMemberAttribute.GetAttribute | ARCCore | ClassMember | Note that illegal to call for -PropertyKeyEnum-. |
| ARCCore.EnumMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.EnumMemberAttribute.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.Extensions | ARCCore | Class | Contains a few general nice to have extensions methods. |
| ARCCore.Extensions.ToStringShort | ARCCore | ClassMember | Returns a shorter representation than -ToStringDB-. |
| ARCCore.Extensions.ToStringDB | ARCCore | ClassMember | Gives the minimum representation of type as string suitable for later reconstruction by -GetType-. |
| ARCCore.Extensions.ForEach | ARCCore | ClassMember | Useful when we want to write collection.ForEach( ... ) instead of |
| ARCCore.Extensions.KeysAsString | ARCCore | ClassMember | Gives a compressed overview of keys in a dictionary. Helpful for building exception messages. |
| ARCCore.Extensions.GetValue | ARCCore | ClassMember | Gives better error messages when reading value from directory if key does not exist |
| ARCCore.Extensions.Single | ARCCore | ClassMember | Same as inbuilt LINQ's Single except that gives a more friendly exception message |
| ARCCore.Extensions.SingleOrDefault | ARCCore | ClassMember | Same as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message |
| ARCCore.IKIP.AssertTypeIntegrity | ARCCore | ClassMember | See -TryAssertTypeIntegrity- for documentation. |
| ARCCore.IKIP.TryAssertTypeIntegrity | ARCCore | ClassMember | Asserts that value is of correct type as specified by the key. |
| ARCCore.IK | ARCCore | Class | IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-. |
| ARCCore.IKCoded | ARCCore | Class | Understands coded and unencoded variants of -IK-. |
| ARCCore.IKCoded.FromEncoded | ARCCore | ClassMember | Note how uses instance cache if already exists there. |
| ARCCore.IKCoded.TryEncode | ARCCore | ClassMember | Returns a string containing only characters in -AllowedEncodedCharacters-. |
| ARCCore.IKCoded.ToString | ARCCore | ClassMember | Returns -Encoded-'s string representation. |
| ARCCore.IKCoded.Encoded | ARCCore | ClassMember | This string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary. |
| 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.IKLong.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.IKString | ARCCore | Class | Index key for any general id, like primary-key or sequence-number or similar. |
| ARCCore.IKString.FromCache | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.IKType.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| ARCCore.ITypeDescriber | ARCCore | Class | Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance). |
| ARCCore.ITypeDescriber.GetSyntaxHelp | ARCCore | ClassMember | Enables explanation of syntax in different contexts from one source: |
| 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.PK.TryGetV | ARCCore | ClassMember | Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter). |
| ARCCore.PK.GetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails |
| ARCCore.PK.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
| ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality | ARCCore | ClassMember | Called from -Initialize- after _cleaner and _validatorAndParser have been set. |
| ARCCore.PK.PackObjectForStorageInEntityObject | ARCCore | ClassMember | See -PackParseResultForStorageInEntityObject- for documentation. |
| ARCCore.PK.FromEnum | ARCCore | ClassMember | Returns the corresponding -PK- instance from the given -PropertyKeyEnum-. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload3 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload2 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.PK.GetTypeMapping | ARCCore | ClassMember | Returns the relevant property key for a given type entity-type and field-type. |
| ARCCore.PK.GetObligatoryValuesForEntityType | ARCCore | ClassMember | Returns all obligatory values (based on -IsObligatory-) |
| 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.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.PK.AllEnums | ARCCore | ClassMember | All enums for the whole application. |
| ARCCore.PK.AllPKEnums | ARCCore | ClassMember | All -PropertyKeyEnum--tagged enums for the whole application. |
| ARCCore.PK.__enum | ARCCore | ClassMember | This information is also found as EnumMember. |
| ARCCore.PKHTMLAttribute | ARCCore | Class | Contains pointer to HTML encoder for a property. |
| ARCCore.PKHTMLAttribute.Encode | ARCCore | ClassMember | Encodes the given string to HTML format through the static method implemented in class -Encoder-. |
| 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.PKHTMLAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.PKHTMLAttribute.Encoder | ARCCore | ClassMember | See -Encoder-. |
| 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.PKRelAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.PKRelAttribute.ForeignEntity | ARCCore | ClassMember | See -ForeignEntity-. |
| ARCCore.PKRelAttribute.OppositeTerm | ARCCore | ClassMember | See -OppositeTerm-. |
| ARCCore.PKRelAttribute.EnforceReferentialIntegrity | ARCCore | ClassMember | See -EnforceReferentialIntegrity-. |
| 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.PKTypeAttribute | ARCCore | Class | Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-. |
| 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. |
| ARCCore.IP | ARCCore | Class | IP = IProperty. |
| ARCCore.IP.TryGetV Overload2 | ARCCore | ClassMember | The actual value of the property. Mostly relevant for single-value properties like -PValue-. |
| ARCCore.IP.Inc | ARCCore | ClassMember | Increments given property key by 1. Sets to 1 if not found. Uses long, not integer. |
| ARCCore.IP.Dec | ARCCore | ClassMember | Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer. |
| ARCCore.IP.Log | ARCCore | ClassMember | The 'final' overload of -Log- that is called by the other overloads. |
| ARCCore.IP.LogExecuteTime | ARCCore | ClassMember | Times the execution of the given function and logs details about elapsed time. |
| ARCCore.IP.HandleException | ARCCore | ClassMember | Note that most relevant to use for -PConcurrent-. |
| ARCCore.IP.TryParseDtr | ARCCore | ClassMember | Parses a PropertyStreamLine- beginning with -dtr-. |
| ARCCore.IP.TrySetPP | ARCCore | ClassMember | SetPP = set property of property. Sets property of entity contained within this class. |
| ARCCore.IP.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| 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.TryGetP | ARCCore | ClassMember | Gets a single property for this object |
| ARCCore.IP.ToPropertyStream | ARCCore | ClassMember | Turns object into a -PropertyStream- |
| ARCCore.IP.ToJSONSerializeable | ARCCore | ClassMember | Prepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize. |
| ARCCore.IP.GetValueForJSONSerializer | ARCCore | ClassMember | Practical approach to serializing of -IP- based values to JSON. |
| ARCCore.IP.TrySetP | ARCCore | ClassMember | Set property regardless of whether exists or not. |
| ARCCore.IP.TryGetPV | ARCCore | ClassMember | Gets a single property's value for the given property key. |
| ARCCore.IP.IsValid | ARCCore | ClassMember | Note that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'. |
| ARCCore.IP.Item | ARCCore | ClassMember | Offers string-based direct indexing. |
| ARCCore.IP.Keys | ARCCore | ClassMember | Returns all the keys for this instance. |
| ARCCore.IP.Values | ARCCore | ClassMember | Returns all the values (all the properties) for this instance. |
| ARCCore.IP.Logger | ARCCore | ClassMember | Describes a logger. |
| ARCCore.IP.AllIPDerivedTypes | ARCCore | ClassMember | All relevant -IP--derived types for the whole application. |
| ARCCore.IP.AllIPDerivedTypesWithPKEnum | ARCCore | ClassMember | All relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-. |
| ARCCore.P.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.ICreated | ARCCore | Class | A dummy interface signifying that implementing class has the ability to store (in-memory) metadata -Created- |
| ARCCore.PCollection | ARCCore | Class | A class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-. |
| ARCCore.PCollection.TrySetPP | ARCCore | ClassMember | Replaces default interface method -TrySetPP-. |
| ARCCore.PCollection.GetKeysEqualToValue | ARCCore | ClassMember | Returns properties which themselves again have key and value equal to the given key and value. |
| ARCCore.PCollection.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.PCollection.TryGetV | ARCCore | 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.PCollection.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.PExact<TEnumType>..ctor | ARCCore | ClassMember | Set capacity to the number of members in the -PropertyKeyEnum- for this class (minus the __invalid-value) |
| ARCCore.PExact<TEnumType>.Storage | ARCCore | ClassMember | Uses int-value of -__enum- minus 1 as index. |
| ARCCore.PII | ARCCore | Class | PII = property for storing individual items. |
| ARCCore.PII.TryGetV | ARCCore | ClassMember | Since value is stored in keys, we need to override this method. |
| ARCCore.PII.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.PII.ToString | ARCCore | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCCore.IPII | ARCCore | Class | Future expansion, using different classes for storing, not only -PII-. |
| ARCCore.IIKII | ARCCore | Class | Related to -PII-, property for storing individual items |
| ARCCore.PValue<T>.DeepCopy | ARCCore | ClassMember | Note that if the generic type (T) is not immutable, then what we return will not be a truly deep copy. |
| ARCCore.PValue<T>..ctor | ARCCore | ClassMember | Note how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide) |
| ARCCore.PValueEmpty | ARCCore | Class | Represents the 'no value'. |
| ARCCore.PValueEmpty.TrySetP | ARCCore | ClassMember | NOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty- |
| ARCCore.PValueEmpty.ToPropertyStream | ARCCore | ClassMember | Typicall return value could be something like |
| ARCCore.ActualConnection | ARCCore | Class | The actual connection, its internal state, queue for sending and so on. |
| ARCCore.ActualConnection.SetMyUpdatePositionGenerator | ARCCore | ClassMember | Set by -StreamProcessor-. |
| ARCCore.ActualConnection.SetSinglePropertyStreamReceiver | ARCCore | ClassMember | Set by -StreamProcessor-. |
| ARCCore.ClientUpdatePosition.OnlyNewDataIsRequested | ARCCore | ClassMember | Used by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data. |
| ARCCore.ClientUpdatePosition.IsGoBack | ARCCore | ClassMember | Has to be translated by -StreamProcessor- into a concrete filename / index. |
| ARCCore.ClientUpdatePosition.IsAtEndOfStream | ARCCore | ClassMember | Necessary in order to implement -AdHocQuery-. |
Generated 2026-02-27 16:29:12.076 UTC