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

128 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCCore.ITypeDescriber.GetSyntaxHelp	ARCCore	ClassMember	Enables explanation of syntax in different contexts from one source:
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.ParseResult.ErrorResponse	ARCCore	ClassMember	Will be null if Result is set
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.PK	ARCCore	Class	PK = AgoRapide PropertyKey.
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.PK.GetA	ARCCore	ClassMember	Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
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.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.PK.TryCleanValidateAndParse	ARCCore	ClassMember	Cleans and parses the value according to specifications for this property key.
ARCCore.ClassAttribute.TryGetAsTypeScript	ARCCore	ClassMember	Generates typescript code corresponding to the class which this instance describes.
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.PK.PackParseResultForStorageInEntityObject	ARCCore	ClassMember	Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
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.EnumAttribute	ARCCore	Class	Describes an enum.
ARCCore.PK.PackObjectForStorageInEntityObject	ARCCore	ClassMember	See -PackParseResultForStorageInEntityObject- for documentation.
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.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.PK.GetAllPKForEntityType	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
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	ARCCore	Class	Describes an enum's value.
ARCCore.PK.GetAllPKForEntityTypeString	ARCCore	ClassMember	Returns all property keys relevant for the given entity type,
ARCCore.IPAttribute	ARCCore	Class	Describes -IP- classes (describes at class-level)
ARCCore.EnumMemberAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PK.BuildFromStringCache	ARCCore	ClassMember	Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.CardinalityExtensions	ARCCore	Class
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.PK..ctor	ARCCore	ClassMember	Constructor with 'object _enum' is necessary in order for ToString to work.
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.PK.Type	ARCCore	ClassMember	Returns type from -PKTypeAttribute-'s -Type-.
ARCCore.Extensions.ToStringVeryShort	ARCCore	ClassMember	Returns same as -ToStringShort- but without any generics information at all.
ARCCore.Extensions.ForEach	ARCCore	ClassMember	Useful when we want to write collection.ForEach( ... ) instead of
ARCCore.PK.AllEnums	ARCCore	ClassMember	All enums for the whole application.
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.PK.AllPKEnums	ARCCore	ClassMember	All -PropertyKeyEnum--tagged enums for the whole application.
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.PK.__enum	ARCCore	ClassMember	This information is also found as EnumMember.
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.IK	ARCCore	Class	IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.PKHTMLAttribute	ARCCore	Class	Contains pointer to HTML encoder for a property.
ARCCore.IKIP	ARCCore	Class	Container class for key (-IK-), and value (-IP-).
ARCCore.IKCoded	ARCCore	Class	Understands coded and unencoded variants of -IK-.
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.IKCoded.FromCacheEncoded	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.IKCoded.ToString	ARCCore	ClassMember	Returns -Encoded-'s string representation.
ARCCore.IHTMLEncoder	ARCCore	Class	Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.IKCoded.FromCacheUnencoded	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.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.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.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.PKRelAttribute	ARCCore	Class	Describes relationships between entities (between tables in RDBMS terms).
ARCCore.IKLong	ARCCore	Class	A more memory efficient alternative to -IKString-.
ARCCore.IKLong.EnrichKey	ARCCore	ClassMember	'Implementing' -ITypeDescriber-.
ARCCore.PKRelAttribute.EnforceReferentialIntegrity	ARCCore	ClassMember	See -EnforceReferentialIntegrity-.
ARCCore.IKString	ARCCore	Class	Index key for any general id, like primary-key or sequence-number or similar.
ARCCore.IKType.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
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.IKString.FromCache	ARCCore	ClassMember	Reduces number of objects generated by caching those known to be within a limited range
ARCCore.ITypeDescriber	ARCCore	Class	Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.PKTypeAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
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.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.Type	ARCCore	ClassMember	See -Type-.
ARCCore.ParseResult.Result	ARCCore	ClassMember	Will be null if ErrorResponse is set.
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.IP	ARCCore	Class	IP = IProperty.
ARCCore.PK.TryGetA	ARCCore	ClassMember	Convenience method for easy access to -BasePKAttribute-.
ARCCore.PK.FromEnum	ARCCore	ClassMember	Returns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.IP.TryGetV Overload2	ARCCore	ClassMember	The actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality	ARCCore	ClassMember	Called from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.IP.Inc	ARCCore	ClassMember	Increments given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.PK.ToString	ARCCore	ClassMember	Caching is supposed to be useful because may be called quite often.
ARCCore.PK.TryGetFromTypeAndFieldName Overload2	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.IP.Dec	ARCCore	ClassMember	Decrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.PK.TryValidateAndParse	ARCCore	ClassMember	Parses the value according to specifications for this property key.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1	ARCCore	ClassMember	Returns property key based on type and field name.
ARCCore.IP.Initialize	ARCCore	ClassMember	Note that has a default implementation (doing nothing).
ARCCore.PK.GetTypeMapping	ARCCore	ClassMember	Returns the relevant property key for a given type entity-type and field-type.
ARCCore.PK.Cardinality	ARCCore	ClassMember	Returns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.IP.AssertIntegrity	ARCCore	ClassMember	See -TryAssertIntegrity-.
ARCCore.PK.GetObligatoryValuesForEntityType	ARCCore	ClassMember	Returns all obligatory values (based on -IsObligatory-)
ARCCore.PK.CorrespondingClass	ARCCore	ClassMember	Returns -CorrespondingClass- based on -__enum-.
ARCCore.IP.TryAssertIntegrity	ARCCore	ClassMember	Asserts the integrity of this entity.
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.ValidatorAndParser	ARCCore	ClassMember	Validates and parses a value.
ARCCore.IP.ToString	ARCCore	ClassMember	The ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
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.Cleaner	ARCCore	ClassMember	Cleanup of values, to be used before value is attempted validated.
ARCCore.IP.TryGetV Overload1	ARCCore	ClassMember	The actual 'unpacking' of the object.
ARCCore.PKHTMLAttribute.Encode	ARCCore	ClassMember	Encodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PKLogAttribute	ARCCore	Class	Explains how logging of changes to a property should be done.
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).
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.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.IP.AddPV Overload2	ARCCore	ClassMember	NOTE: The different AddPV / AddP overloads should only be used if you want an assertion against the
ARCCore.PKHTMLAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.PKLogAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
ARCCore.IP.AddPV Overload1	ARCCore	ClassMember	Adds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCCore.PKHTMLAttribute.Encoder	ARCCore	ClassMember	See -Encoder-.
ARCCore.PKLogAttribute.DoNotLogAtAll	ARCCore	ClassMember	See -DoNotLogAtAll-.
ARCCore.IP.Values	ARCCore	ClassMember	Returns all the values (all the properties) for this instance.
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.PKTypeAttribute	ARCCore	Class	Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.
ARCCore.IP.Logger	ARCCore	ClassMember	Describes a logger.
ARCCore.PKRelAttribute.TryRemoveP	ARCCore	ClassMember	Should probably never be used.
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.AllIPDerivedTypes	ARCCore	ClassMember	All relevant -IP--derived types for the whole application.
ARCCore.PKRelAttribute.ForeignEntity	ARCCore	ClassMember	See -ForeignEntity-.
ARCCore.PKTypeAttribute.StandardValidatorAndParser	ARCCore	ClassMember	Returns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.
ARCCore.IP.AllIPDerivedTypesWithPKEnum	ARCCore	ClassMember	All relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.PKRelAttribute.OppositeTerm	ARCCore	ClassMember	See -OppositeTerm-.
ARCCore.PKTypeAttribute.StandardCleaner	ARCCore	ClassMember	Returns a cleaner for well known types like bool
ARCCore.IP.AllIPDerivedTypesDictIKType	ARCCore	ClassMember	Same as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.PKTypeAttribute.Cardinality	ARCCore	ClassMember	See -Cardinality-.
ARCCore.IP.Log	ARCCore	ClassMember	The 'final' overload of -Log- that is called by the other overloads.
ARCCore.P	ARCCore	Class	'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCCore.PKTypeAttribute.DefaultValue	ARCCore	ClassMember	See -DefaultValue-.
ARCCore.IP.LogExecuteTime	ARCCore	ClassMember	Times the execution of the given function and logs details about elapsed time.
ARCCore.P.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.PKTypeAttribute.IsObligatory	ARCCore	ClassMember	See -IsObligatory-.

Generated 2025-07-12 02:19:09.357 UTC