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

112 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.IKCoded.TryCheckValidEncodedValueARCCoreClassMemberChecks if encoded value is valid.
ARCCore.IKCoded.ToStringARCCoreClassMemberReturns -Encoded-'s string representation.
ARCCore.IKCoded.EncodedARCCoreClassMemberThis string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary.
ARCCore.IKLong.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.PK.TryGetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute-.
ARCCore.PK.FromEnumARCCoreClassMemberReturns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.PK.GetTypeMappingARCCoreClassMemberReturns the relevant property key for a given type entity-type and field-type.
ARCCore.PK.TryGetVARCCoreClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCCore.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.TypeARCCoreClassMemberReturns type from -PKTypeAttribute-'s -Type-.
ARCCore.PK.CardinalityARCCoreClassMemberReturns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.IHTMLEncoderARCCoreClassPseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML.
ARCCore.PKLogAttributeARCCoreClassExplains how logging of changes to a property should be done.
ARCCore.PKLogAttribute.InitializeARCCoreClassMemberTo 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.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKTypeAttributeARCCoreClassContains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.
ARCCore.PKTypeAttribute.InitializeARCCoreClassMemberTo 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.StandardValidatorAndParserARCCoreClassMemberReturns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.
ARCCore.PKTypeAttribute.StandardCleanerARCCoreClassMemberReturns a cleaner for well known types like bool
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.IP.LogARCCoreClassMemberThe 'final' overload of -Log- that is called by the other overloads.
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCCore.IP.TryGetP Overload1ARCCoreClassMemberGets a single property for this object
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberMakes the following modifications to the data:
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCCore.IP.GetOrAddPVARCCoreClassMemberGets value. If not set then value will be added
ARCCore.IP.GetPARCCoreClassMemberGets a single property for this object.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDictARCCoreClassMemberAll -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstractARCCoreClassMemberAll relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCCore.IP.AllIPDerivedTypesDictARCCoreClassMemberOffers for lookup of a type given its string representation.
ARCCore.IP.AllIPDerivedTypesDictIKTypeARCCoreClassMemberSame as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.PCollectionARCCoreClassA class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCCore.PCollection.TrySetPPARCCoreClassMemberReplaces default interface method -TrySetPP-.
ARCCore.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.PCollection.TryGetVARCCoreClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCCore.IIKII.PackParseResultForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackParseResultForStorageInEntityObject-.
ARCCore.IIKII.PackObjectForStorageInIKIIARCCoreClassMemberThis method corresponds to -PackObjectForStorageInEntityObject-.
ARCCore.PRichARCCoreClassFully flexible storage. Can store anything. Typical inherited for entity representations like 'Customer' or 'Order'.
ARCCore.PRich.TryGetVARCCoreClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).
ARCCore.PRich.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PValue<T>ARCCoreClassSingle value storage.
ARCCore.PValue<T>.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.PValue<T>.TryGetVARCCoreClassMemberSupports duck typing.
ARCCore.EnumAttributeARCCoreClassDescribes an enum.
ARCCore.BaseAttributeARCCoreClassInstances of this class are used as source of documentation and data for the API.
ARCCore.EnumMemberAttribute.GetAttributeARCCoreClassMemberNote that illegal to call for -PropertyKeyEnum-.
ARCCore.BaseAttribute.IsDefaultARCCoreClassMemberDoes 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.InitializeARCCoreClassMemberTo 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.GetAttributesARCCoreClassMemberNote that illegal to call for other than -PropertyKeyEnum-.
ARCCore.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.BasePKAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.ClassAttributeARCCoreClassDescribes a class.
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.ClassAttribute.GetAttributeARCCoreClassMemberThrows 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.Extensions.UseARCCoreClassMemberConvenience 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.ClassAttribute.IsDefaultARCCoreClassMemberDoes 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.AddValueARCCoreClassMemberGives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCCore.IKCodedARCCoreClassUnderstands coded and unencoded variants of -IK-.
ARCCore.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.PKHTMLAttributeARCCoreClassContains pointer to HTML encoder for a property.
ARCCore.IKARCCoreClassIK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.PKHTMLAttribute.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.PValueEmptyARCCoreClassRepresents the 'no value'.
ARCCore.IKString.FromStringARCCoreClassMemberNote how uses instance cache if already exists there
ARCCore.PValueEmpty.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
ARCCore.ParseResult.ResultARCCoreClassMemberWill be null if ErrorResponse is set.
ARCCore.ClientUpdatePosition.OnlyNewDataIsRequestedARCCoreClassMemberUsed by the subscribing client to signify that it does not care about historical data, the server may start with sending only new data.
ARCCore.ParseResult.ErrorResponseARCCoreClassMemberWill be null if Result is set
ARCCore.ClientUpdatePosition.IsGoBackARCCoreClassMemberHas to be translated by -StreamProcessor- into a concrete filename / index.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.PropertyStreamLineARCCoreClassHas two main functions:
ARCCore.PK.TryGetEnumARCCoreClassMemberNote 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.PropertyStreamLine.EncodeKeysARCCoreClassMemberEncodes the key part of a -PropertyStreamLine-.
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PropertyStreamLine.EncodeValuesARCCoreClassMemberTypically used when turning -WholeCollection- into a value part of a -PropertyStreamLine-.
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PropertyStreamLine.EncodeKeyPartARCCoreClassMemberConverts a single key part of a -PropertyStreamLine- to a format suitable for sending over a -PropertyStream-.
ARCCore.PK.GetObligatoryValuesForEntityTypeARCCoreClassMemberReturns all obligatory values (based on -IsObligatory-)
ARCCore.PropertyStreamLine.TryStoreARCCoreClassMemberStores the given -PropertyStreamLineParsed- in the given storage object.
ARCCore.PK.EqualsARCCoreClassMemberNote 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.PropertyStreamLine.AllowedKeyCharsARCCoreClassMemberAllowed characters in the Key-part of a -PropertyStreamLine-.
ARCCore.PK.AllPKEnumsARCCoreClassMemberAll -PropertyKeyEnum--tagged enums for the whole application.
ARCCore.StreamProcessor.CreateBareBonesInstanceARCCoreClassMemberCreates a bare-bones -StreamProcessor- instance.
ARCCore.PK.__enumARCCoreClassMemberThis information is also found as EnumMember.
ARCCore.StreamProcessor.InitializeARCCoreClassMemberInitializes this instance of -StreamProcessor-
ARCCore.PKHTMLAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.StreamProcessor.AddOrRemoveOutgoingConnectionsARCCoreClassMemberNot relevant for -CoreDB-.
ARCCore.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.StreamProcessor.StartTCPIPCommunicationARCCoreClassMemberStarts communicating over TCP/IP.
ARCCore.PKHTMLAttribute.EncoderARCCoreClassMemberSee -Encoder-.
ARCCore.StreamProcessor.ReceiveAndDistributeARCCoreClassMemberProcess all messages in receive queue.
ARCCore.PKHTMLAttribute.IsDefaultARCCoreClassMemberDoes 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.StreamProcessor.AddTimestampAsRequiredARCCoreClassMemberAdds -Timestamp- to the property stream (to -_queueReceive-) as specified by -TimestampResolution-.
ARCCore.PKRelAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.StorageFileARCCoreClassImplemented only in order to store some ideas about -Hash-.
ARCCore.PKRelAttribute.ForeignEntityARCCoreClassMemberSee -ForeignEntity-.

Generated 2026-11-04 06:46:42.679 UTC