[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 32 > < TAKE 124 >

124 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.IKDate	ARCCore	Class	A more memory efficient alternative to -IKString- (together with -IKLong-).
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.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
ARCCore.PK.TryValidateAndParse	ARCCore	ClassMember	Parses the value according to specifications for this property key.
ARCCore.PK.TryCleanValidateAndParse	ARCCore	ClassMember	Cleans and parses the value according to specifications for this property key.
ARCCore.PK.PackParseResultForStorageInEntityObject	ARCCore	ClassMember	Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
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..ctor	ARCCore	ClassMember	Constructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.Type	ARCCore	ClassMember	Returns type from -PKTypeAttribute-'s -Type-.
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.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.IHTMLEncoder	ARCCore	Class	Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.PKLogAttribute	ARCCore	Class	Explains how logging of changes to a property should be done.
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.
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.PKTypeAttribute.StandardValidatorAndParser	ARCCore	ClassMember	Returns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.
ARCCore.PKTypeAttribute.StandardCleaner	ARCCore	ClassMember	Returns a cleaner for well known types like bool
ARCCore.PKTypeAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PKTypeAttribute.Type	ARCCore	ClassMember	See -Type-.
ARCCore.BaseAttribute	ARCCore	Class	Instances of this class are used as source of documentation and data for the API.
ARCCore.BaseAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.BasePKAttribute	ARCCore	Class	The class containing the actual attributes used for -TaggingOfPropertyKeys-.
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.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.GetAttribute	ARCCore	ClassMember	Throws exception if type implements -IP- and no corresponding enum found (enum ending with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance)
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.ClassAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.EnumAttribute.GetAttribute	ARCCore	ClassMember	Throws exception if tagged as -PropertyKeyEnum- and name of type does not end with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance).
ARCCore.ClassMemberAttribute.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.EnumMemberAttribute	ARCCore	Class	Describes an enum's value.
ARCCore.EnumAttribute.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.EnumMemberAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.EnumAttribute.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.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.CardinalityExtensions.IsMultiple	ARCCore	ClassMember	Returns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.Extensions.ToStringDB	ARCCore	ClassMember	Gives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.Extensions	ARCCore	Class	Contains a few general nice to have extensions methods.
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.Result	ARCCore	ClassMember	Returns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.Extensions.GetValue	ARCCore	ClassMember	Gives better error messages when reading value from directory if key does not exist
ARCCore.Extensions.ToStringDateAndTime	ARCCore	ClassMember	Uses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.Extensions.ToStringWithMS	ARCCore	ClassMember	Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCCore.IKCoded.FromEncoded	ARCCore	ClassMember	Note how uses instance cache if already exists there.
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCCore.IKCoded.TryEncode	ARCCore	ClassMember	Returns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.IKCoded.FromCacheEncoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKDate.ValidDateTimeFormats	ARCCore	ClassMember	Note: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK.
ARCCore.IKCoded.FromCacheUnencoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKLong	ARCCore	Class	A more memory efficient alternative to -IKString-.
ARCCore.IKDate.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.IKString.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKDate.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKType	ARCCore	Class	Index key used when storing a collection of a given type, like 'Customer'.
ARCCore.IKString.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
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.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
ARCCore.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
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.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.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.PackObjectForStorageInEntityObject	ARCCore	ClassMember	See -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality	ARCCore	ClassMember	Called from -Initialize- after _cleaner and _validatorAndParser have been set.
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.GetAllPKForEntityTypeString	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.PK.TryGetFromTypeAndFieldName Overload2	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK.BuildFromStringCache	ARCCore	ClassMember	Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1	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.GetAllPKForEntityType	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.PK.GetObligatoryValuesForEntityType	ARCCore	ClassMember	Returns all obligatory values (based on -IsObligatory-)
ARCCore.PK.Cardinality	ARCCore	ClassMember	Returns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.PKHTMLAttribute.Encode	ARCCore	ClassMember	Encodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PK.CorrespondingClass	ARCCore	ClassMember	Returns -CorrespondingClass- based on -__enum-.
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.ValidatorAndParser	ARCCore	ClassMember	Validates and parses a value.
ARCCore.PKHTMLAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PK.Cleaner	ARCCore	ClassMember	Cleanup of values, to be used before value is attempted validated.
ARCCore.PKHTMLAttribute.Encoder	ARCCore	ClassMember	See -Encoder-.
ARCCore.PKLogAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
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.PKLogAttribute.DoNotLogAtAll	ARCCore	ClassMember	See -DoNotLogAtAll-.
ARCCore.PKRelAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
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.PKRelAttribute.ForeignEntity	ARCCore	ClassMember	See -ForeignEntity-.
ARCCore.PKRelAttribute	ARCCore	Class	Describes relationships between entities (between tables in RDBMS terms).
ARCCore.PKRelAttribute.OppositeTerm	ARCCore	ClassMember	See -OppositeTerm-.
ARCCore.IP	ARCCore	Class	IP = IProperty.
ARCCore.PKTypeAttribute.Cardinality	ARCCore	ClassMember	See -Cardinality-.
ARCCore.IP.TryGetV Overload2	ARCCore	ClassMember	The actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.PKTypeAttribute.DefaultValue	ARCCore	ClassMember	See -DefaultValue-.
ARCCore.IP.Inc	ARCCore	ClassMember	Increments given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.PKTypeAttribute.IsObligatory	ARCCore	ClassMember	See -IsObligatory-.
ARCCore.IP.Dec	ARCCore	ClassMember	Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
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.IP.ToPropertyStream	ARCCore	ClassMember	Turns object into a -PropertyStream-
ARCCore.IP.TrySetPP	ARCCore	ClassMember	SetPP = set property of property. Sets property of entity contained within this class.
ARCCore.IP.ToJSONSerializeable	ARCCore	ClassMember	Prepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.IP.GetKeysEqualToValue	ARCCore	ClassMember	Returns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.GetValueForJSONSerializer	ARCCore	ClassMember	Practical approach to serializing of -IP- based values to JSON.
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.TrySetP	ARCCore	ClassMember	Set property regardless of whether exists or not.
ARCCore.IP.TryGetP	ARCCore	ClassMember	Gets a single property for this object
ARCCore.IP.TryGetV Overload1	ARCCore	ClassMember	The actual 'unpacking' of the object.
ARCCore.IP.AddP	ARCCore	ClassMember	Adds a property for this object.
ARCCore.IP.DeepCopy	ARCCore	ClassMember	Creates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).

Generated 2025-06-21 12:38:47.716 UTC