[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	ARCCore	Class	Instances of this class are used as source of documentation and data for the API.
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	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.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.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.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.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.IK	ARCCore	Class	IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
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.Extensions.ToStringShort	ARCCore	ClassMember	Returns a shorter representation than -ToStringDB-.
ARCCore.BaseAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.IKCoded.TryCheckValidEncodedValue	ARCCore	ClassMember	Checks if encoded value is valid.
ARCCore.ClassAttribute	ARCCore	Class	Describes a class.
ARCCore.Extensions.ToStringVeryShort	ARCCore	ClassMember	Returns same as -ToStringShort- but without any generics information at all.
ARCCore.BasePKAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.IKCoded.FromEncoded	ARCCore	ClassMember	Note how uses instance cache if already exists there.
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.Extensions.ToStringDB	ARCCore	ClassMember	Gives the minimum representation of type as string suitable for later reconstruction by -GetType-.
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.IKDate	ARCCore	Class	A more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.ClassMemberAttribute	ARCCore	Class	Describes a member of a class (a method).
ARCCore.Extensions.ForEach	ARCCore	ClassMember	Useful when we want to write collection.ForEach( ... ) instead of
ARCCore.ClassAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the class which this instance describes.
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.ClassMemberAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.Extensions.Single	ARCCore	ClassMember	Same as inbuilt LINQ's Single except that gives a more friendly exception message
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.IKString.FromCache	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
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.Extensions.SingleOrDefault	ARCCore	ClassMember	Same as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
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.IKType.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
ARCCore.EnumMemberAttribute	ARCCore	Class	Describes an enum's value.
ARCCore.Extensions.Result	ARCCore	ClassMember	Returns heading plus return-value of function (calls function). If function == null then empty string is returned
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.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.EnumMemberAttribute.GetAttribute	ARCCore	ClassMember	Note that illegal to call for -PropertyKeyEnum-.
ARCCore.Extensions.ToStringDateAndTime	ARCCore	ClassMember	Uses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.CardinalityExtensions	ARCCore	Class
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
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.IKCoded	ARCCore	Class	Understands coded and unencoded variants of -IK-.
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.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
ARCCore.IPAttribute	ARCCore	Class	Describes -IP- classes (describes at class-level)
ARCCore.IKCoded.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.Extensions	ARCCore	Class	Contains a few general nice to have extensions methods.
ARCCore.PK.TryCleanValidateAndParse	ARCCore	ClassMember	Cleans and parses the value according to specifications for this property key.
ARCCore.Extensions.KeysAsString	ARCCore	ClassMember	Gives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.IKCoded.TryEncode	ARCCore	ClassMember	Returns a string containing only characters in -AllowedEncodedCharacters-.
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.PK.PackParseResultForStorageInEntityObject	ARCCore	ClassMember	Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.Extensions.GetValue	ARCCore	ClassMember	Gives better error messages when reading value from directory if key does not exist
ARCCore.IKCoded.ToString	ARCCore	ClassMember	Returns -Encoded-'s string representation.
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.PK.GetAllPKForEntityTypeString	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
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.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.IKIP.AssertTypeIntegrity	ARCCore	ClassMember	See -TryAssertTypeIntegrity- for documentation.
ARCCore.PK.BuildFromStringCache	ARCCore	ClassMember	Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCCore.IKCoded.AllowedEncodedCharacters	ARCCore	ClassMember	The character set 'A...Za...z0...9-_().,='.
ARCCore.IKIP.TryAssertTypeIntegrity	ARCCore	ClassMember	Asserts that value is of correct type as specified by the key.
ARCCore.PK..ctor	ARCCore	ClassMember	Constructor with 'object _enum' is necessary in order for ToString to work.
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.IKString.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.IKCoded.FromCacheEncoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.PK.Type	ARCCore	ClassMember	Returns type from -PKTypeAttribute-'s -Type-.
ARCCore.IKLong	ARCCore	Class	A more memory efficient alternative to -IKString-.
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.IKCoded.FromCacheUnencoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.PK.ValidatorAndParser	ARCCore	ClassMember	Validates and parses a value.
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.IKString.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
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.PK.Cleaner	ARCCore	ClassMember	Cleanup of values, to be used before value is attempted validated.
ARCCore.PK.GetA	ARCCore	ClassMember	Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.IKType	ARCCore	Class	Index key used when storing a collection of a given type, like 'Customer'.
ARCCore.IKDate.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.PK.__enum	ARCCore	ClassMember	This information is also found as EnumMember.
ARCCore.PK.PackObjectForStorageInEntityObject	ARCCore	ClassMember	See -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PK.TryGetA	ARCCore	ClassMember	Convenience method for easy access to -BasePKAttribute-.
ARCCore.IKLong.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.PKHTMLAttribute	ARCCore	Class	Contains pointer to HTML encoder for a property.
ARCCore.PK.FromEnum	ARCCore	ClassMember	Returns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality	ARCCore	ClassMember	Called from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.IKString	ARCCore	Class	Index key for any general id, like primary-key or sequence-number or similar.
ARCCore.PKLogAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PK.Cardinality	ARCCore	ClassMember	Returns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.PK.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.PKLogAttribute.DoNotLogAtAll	ARCCore	ClassMember	See -DoNotLogAtAll-.
ARCCore.PK.CorrespondingClass	ARCCore	ClassMember	Returns -CorrespondingClass- based on -__enum-.
ARCCore.PK.TryValidateAndParse	ARCCore	ClassMember	Parses the value according to specifications for this property key.
ARCCore.ITypeDescriber.GetSyntaxHelp	ARCCore	ClassMember	Enables explanation of syntax in different contexts from one source:
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.PK.AllEnums	ARCCore	ClassMember	All enums for the whole application.
ARCCore.PK.GetTypeMapping	ARCCore	ClassMember	Returns the relevant property key for a given type entity-type and field-type.
ARCCore.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
ARCCore.PKRelAttribute	ARCCore	Class	Describes relationships between entities (between tables in RDBMS terms).
ARCCore.PK.AllPKEnums	ARCCore	ClassMember	All -PropertyKeyEnum--tagged enums for the whole application.
ARCCore.PK.GetObligatoryValuesForEntityType	ARCCore	ClassMember	Returns all obligatory values (based on -IsObligatory-)
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.PKTypeAttribute.Cardinality	ARCCore	ClassMember	See -Cardinality-.
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.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.TryGetFromTypeAndFieldName Overload3	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PKTypeAttribute.DefaultValue	ARCCore	ClassMember	See -DefaultValue-.
ARCCore.PKRelAttribute.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.PK.TryGetFromTypeAndFieldName Overload2	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.PKTypeAttribute.IsObligatory	ARCCore	ClassMember	See -IsObligatory-.
ARCCore.PKRelAttribute.ForeignEntity	ARCCore	ClassMember	See -ForeignEntity-.
ARCCore.PKHTMLAttribute.Encode	ARCCore	ClassMember	Encodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1	ARCCore	ClassMember	Returns property key based on type and field name.
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.)

Generated 2026-06-12 09:51:13.219 UTC