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

120 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.Extensions.Use	ARCCore	ClassMember	Convenience method that shortens down code in cases where an instance of an object must be created first in order to use that same variable multiple times
ARCCore.Extensions.SingleOrDefault	ARCCore	ClassMember	Same as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.Extensions.Result	ARCCore	ClassMember	Returns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCCore.IKIP.AssertTypeIntegrity	ARCCore	ClassMember	See -TryAssertTypeIntegrity- for documentation.
ARCCore.IKCoded	ARCCore	Class	Understands coded and unencoded variants of -IK-.
ARCCore.IKCoded.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.IKCoded.FromCacheUnencoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
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.IKDate.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
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.IKLong	ARCCore	Class	A more memory efficient alternative to -IKString-.
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.IKType	ARCCore	Class	Index key used when storing a collection of a given type, like 'Customer'.
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.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.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.TryGetFromTypeAndFieldName Overload2	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK.GetAllPKForEntityType	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.PK.GetAllPKForEntityTypeString	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.PK.CorrespondingClass	ARCCore	ClassMember	Returns -CorrespondingClass- based on -__enum-.
ARCCore.PK.ValidatorAndParser	ARCCore	ClassMember	Validates and parses a value.
ARCCore.PK.Cleaner	ARCCore	ClassMember	Cleanup of values, to be used before value is attempted validated.
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.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.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.Initialize	ARCCore	ClassMember	Note that has a default implementation (doing nothing).
ARCCore.IP.AssertIntegrity	ARCCore	ClassMember	See -TryAssertIntegrity-.
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.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.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.BasePKAttribute	ARCCore	Class	The class containing the actual attributes used for -TaggingOfPropertyKeys-.
ARCCore.ClassAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the class which this instance describes.
ARCCore.BasePKAttribute.GetAttributes	ARCCore	ClassMember	Note that illegal to call for other than -PropertyKeyEnum-.
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.BasePKAttribute.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.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.EnumMemberAttribute.GetAttribute	ARCCore	ClassMember	Note that illegal to call for -PropertyKeyEnum-.
ARCCore.ClassAttribute.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.ClassMemberAttribute	ARCCore	Class	Describes a member of a class (a method).
ARCCore.Extensions.ToStringDB	ARCCore	ClassMember	Gives the minimum representation of type as string suitable for later reconstruction by -GetType-.
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.Extensions.AddValue	ARCCore	ClassMember	Gives better error messages compared to 'original' Add when adding a value to a directory if key already exists
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.Extensions.KeysAsString	ARCCore	ClassMember	Gives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.EnumMemberAttribute	ARCCore	Class	Describes an enum's value.
ARCCore.Extensions.ToStringDateAndTime	ARCCore	ClassMember	Uses format 'yyyy-MM-dd HH:mm:ss.fff'.
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.ToStringWithMS	ARCCore	ClassMember	Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCCore.Extensions	ARCCore	Class	Contains a few general nice to have extensions methods.
ARCCore.IKCoded.TryCheckValidEncodedValue	ARCCore	ClassMember	Checks if encoded value is valid.
ARCCore.Extensions.GetValue	ARCCore	ClassMember	Gives better error messages when reading value from directory if key does not exist
ARCCore.IKCoded.FromCacheEncoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.Extensions.Single	ARCCore	ClassMember	Same as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.IKDate	ARCCore	Class	A more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.IKIP.TryAssertTypeIntegrity	ARCCore	ClassMember	Asserts that value is of correct type as specified by the key.
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.IK	ARCCore	Class	IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.IKString.FromCache	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
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.IKString.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.IKCoded.AllowedEncodedCharacters	ARCCore	ClassMember	The character set 'A...Za...z0...9-_().,='.
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.IKLong.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
ARCCore.IKString	ARCCore	Class	Index key for any general id, like primary-key or sequence-number or similar.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality	ARCCore	ClassMember	Called from -Initialize- after _cleaner and _validatorAndParser have been 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.PK.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
ARCCore.IKString.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.PK.FromEnum	ARCCore	ClassMember	Returns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
ARCCore.PK.TryGetFromTypeAndFieldName Overload3	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
ARCCore.PK.BuildFromStringCache	ARCCore	ClassMember	Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.PK.TryValidateAndParse	ARCCore	ClassMember	Parses the value according to specifications for this property key.
ARCCore.PK.GetTypeMapping	ARCCore	ClassMember	Returns the relevant property key for a given type entity-type and field-type.
ARCCore.PK.TryCleanValidateAndParse	ARCCore	ClassMember	Cleans and parses the value according to specifications for this property key.
ARCCore.PK.GetObligatoryValuesForEntityType	ARCCore	ClassMember	Returns all obligatory values (based on -IsObligatory-)
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.PackObjectForStorageInEntityObject	ARCCore	ClassMember	See -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PKHTMLAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
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.PKHTMLAttribute.Encoder	ARCCore	ClassMember	See -Encoder-.
ARCCore.PK..ctor	ARCCore	ClassMember	Constructor with 'object _enum' is necessary in order for ToString to work.
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.PK.Type	ARCCore	ClassMember	Returns type from -PKTypeAttribute-'s -Type-.
ARCCore.IHTMLEncoder	ARCCore	Class	Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.PK.Cardinality	ARCCore	ClassMember	Returns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.PKTypeAttribute.Type	ARCCore	ClassMember	See -Type-.
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.PKTypeAttribute.Cardinality	ARCCore	ClassMember	See -Cardinality-.
ARCCore.PKLogAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PKTypeAttribute.DefaultValue	ARCCore	ClassMember	See -DefaultValue-.
ARCCore.PKLogAttribute.DoNotLogAtAll	ARCCore	ClassMember	See -DoNotLogAtAll-.
ARCCore.PKTypeAttribute.IsObligatory	ARCCore	ClassMember	See -IsObligatory-.
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.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).

Generated 2025-06-21 21:45:59.775 UTC