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

96 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
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.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.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.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.GetAttributes	ARCCore	ClassMember	Note that illegal to call for other than -PropertyKeyEnum-.
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.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.ClassAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the class which this instance describes.
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	ARCCore	Class	Describes a member of a class (a method).
ARCCore.EnumAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the enum which this instance describes.
ARCCore.EnumAttribute	ARCCore	Class	Describes an enum.
ARCCore.EnumMemberAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
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	ARCCore	Class	Contains a few general nice to have extensions methods.
ARCCore.EnumAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.Extensions.ToStringShort	ARCCore	ClassMember	Returns a shorter representation than -ToStringDB-.
ARCCore.EnumMemberAttribute.GetAttribute	ARCCore	ClassMember	Note that illegal to call for -PropertyKeyEnum-.
ARCCore.Extensions.ToStringVeryShort	ARCCore	ClassMember	Returns same as -ToStringShort- but without any generics information at all.
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.Extensions.KeysAsString	ARCCore	ClassMember	Gives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.CardinalityExtensions	ARCCore	Class
ARCCore.Extensions.GetValue	ARCCore	ClassMember	Gives better error messages when reading value from directory if key does not exist
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.ToStringDB	ARCCore	ClassMember	Gives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCCore.Extensions.ForEach	ARCCore	ClassMember	Useful when we want to write collection.ForEach( ... ) instead of
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.IKCoded.FromCacheUnencoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.Extensions.SingleOrDefault	ARCCore	ClassMember	Same as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.IKCoded.AllowedEncodedCharacters	ARCCore	ClassMember	The character set 'A...Za...z0...9-_().,='.
ARCCore.IK	ARCCore	Class	IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.IKDate	ARCCore	Class	A more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.IKCoded	ARCCore	Class	Understands coded and unencoded variants of -IK-.
ARCCore.IKString	ARCCore	Class	Index key for any general id, like primary-key or sequence-number or similar.
ARCCore.IKCoded.ToString	ARCCore	ClassMember	Returns -Encoded-'s string representation.
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.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
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.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.IKLong.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
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.FromString	ARCCore	ClassMember	Note how uses instance cache if already exists there
ARCCore.PK.GetA	ARCCore	ClassMember	Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
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.TryGetFromTypeAndFieldName Overload3	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.ITypeDescriber.GetSyntaxHelp	ARCCore	ClassMember	Enables explanation of syntax in different contexts from one source:
ARCCore.PK.TryGetFromTypeAndFieldName Overload2	ARCCore	ClassMember	Returns property key based on type and field name.
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.TryGetFromTypeAndFieldName Overload1	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
ARCCore.PK.GetAllPKForEntityType	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
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.TryCleanValidateAndParse	ARCCore	ClassMember	Cleans and parses the value according to specifications for this property key.
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.PackParseResultForStorageInEntityObject	ARCCore	ClassMember	Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PK..ctor	ARCCore	ClassMember	Constructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.PackObjectForStorageInEntityObject	ARCCore	ClassMember	See -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PK.Type	ARCCore	ClassMember	Returns type from -PKTypeAttribute-'s -Type-.
ARCCore.PK.FromEnum	ARCCore	ClassMember	Returns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PKHTMLAttribute.Encode	ARCCore	ClassMember	Encodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PK.Cardinality	ARCCore	ClassMember	Returns cardinality from -PKTypeAttribute-'s -Cardinality-.
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.CorrespondingClass	ARCCore	ClassMember	Returns -CorrespondingClass- based on -__enum-.
ARCCore.PKHTMLAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PK.ValidatorAndParser	ARCCore	ClassMember	Validates and parses a value.
ARCCore.PKHTMLAttribute.Encoder	ARCCore	ClassMember	See -Encoder-.
ARCCore.PK.Cleaner	ARCCore	ClassMember	Cleanup of values, to be used before value is attempted validated.
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.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PKRelAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PKLogAttribute.DoNotLogAtAll	ARCCore	ClassMember	See -DoNotLogAtAll-.
ARCCore.PKRelAttribute.ForeignEntity	ARCCore	ClassMember	See -ForeignEntity-.
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.OppositeTerm	ARCCore	ClassMember	See -OppositeTerm-.

Generated 2026-07-03 00:23:05.401 UTC