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

256 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.StreamProcessor+StorageFile.FilenameARCCoreClassMemberFilename: Main file name, like 2020-04-03 08:42
ARCCore.ARConcepts.TaggingOfPropertyKeysARCCoreEnumMemberThe concept of specifying in a single place all relevant information about a given property (data field).
ARCQuery.FunctionKeyAbs.SyntaxHelpARCQueryClassMember'Abs()'
ARCCore.ClassMemberAttributeP.DeclaringTypeARCCoreEnumMemberThe actual MemberInfo.DeclaringType.
ARCQuery.TranslationSingle.TryGetVARCQueryClassMemberNote 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).
ARCQuery.FunctionKeyDateARCQueryClassFormats a date without time component.
ARCCore.ClassMemberAttributeP.MethodNameARCCoreEnumMemberThe actual MemberInfo.Name.
ARCQuery.TranslationSingle.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyDate.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ClassMemberAttributeP.MethodSignatureARCCoreEnumMemberThe actual MemberInfo.ToString.
ARCQuery.TranslationSingle.ReferenceCountARCQueryClassMemberMay be set from outside, for instance with System.Threading.Interlocked.Increment.
ARCQuery.FunctionKeyDate.SyntaxHelpARCQueryClassMember'Date()'
ARCCore.EnumAttributePARCCoreEnumDescribes class -EnumAttribute-.
ARCQuery.UtilQueryARCQueryClassUtility methods for -ARCQuery-.
ARCQuery.FunctionKeyDayOfWeekARCQueryClassExtracts DayOfWeek from field like 'Monday', 'Tuesday' and so on.
ARCCore.EnumAttributeP.AssemblyNameARCCoreEnumMemberThe assembly in which this class resides.
ARCQuery.UtilQuery.IndexOfOutsideOfARCQueryClassMemberEquivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.FunctionKeyDayOfWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.EnumAttributeP.EnumNamespaceARCCoreEnumMemberThe namespace for -EnumType-.
ARCQuery.UtilQuery.IndexOfAnyOutsideOfARCQueryClassMemberEquivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.FunctionKeyDayOfWeek.SyntaxHelpARCQueryClassMember'DayOfWeek()'
ARCCore.EnumAttributeP.EnumTypeARCCoreEnumMemberThe type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for
ARCQuery.UtilQuery.SplitOutsideOfARCQueryClassMemberEquivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCQuery.FunctionKeyDoubleARCQueryClassConverts an integer to a double (decimal value).
ARCCore.EnumAttributeP.AREnumTypeARCCoreEnumMemberNote that will default to -__invalid- if not explicit set.
ARCQuery.UtilQuery.SpecialLinkPrefixesARCQueryClassMemberContains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.FunctionKeyDouble.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.EnumAttributeP.CorrespondingClassARCCoreEnumMemberOnly relevant when -PropertyKeyEnum-.
ARCQuery.FunctionKeyDouble.SyntaxHelpARCQueryClassMember'Double()'
ARCCore.EnumMemberAttributePARCCoreEnumDescribes class -EnumMemberAttribute-.
ARCQuery.FunctionKeyFirstLineARCQueryClassExtracts first line from string of text.
ARCCore.EnumMemberAttributeP.EnumTypeARCCoreEnumMemberThe type of the enum (like type of 'CustomerP' in CustomerP.FirstName) that we are an attribute for
ARCQuery.FunctionKeyFirstLine.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.EnumMemberAttributeP.EnumMemberARCCoreEnumMemberThe actual enum member / enum value (like 'Firstname' in CustomerP.FirstName) that we are an attribute for
ARCQuery.FunctionKeyFirstLine.SyntaxHelpARCQueryClassMember'FirstLine()'
ARCCore.ARComponentsARCCoreEnumARComponents = AgoRapide Components. Contains short descriptions of the different 'official' AgoRapide components.
ARCQuery.FunctionKeyVeryShortARCQueryClassReturns the -ToStringVeryShort- representation of the given type.
ARCCore.ARComponents.ARCCoreARCCoreEnumMemberA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.FunctionKeyVeryShort.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ARComponents.ARADBARCCoreEnumMemberAn application constituting the full functionality of a -CoreDB- (linking to -ARCCore-).
ARCQuery.FunctionKeyVeryShort.SyntaxHelpARCQueryClassMember'VeryShort()'
ARCCore.ARComponents.ARAClientARCCoreEnumMemberA template application for a -Client- (linking to -ARCCore-).
ARCQuery.FunctionKeyHourMinuteARCQueryClassFormats a timespan with only the hour and minute part. Uses format hh:mm.
ARCCore.ARConcepts.PropertyAccessARCCoreEnumMemberThe general mechanism for accessing properties of objects in AgoRapide.
ARCQuery.FunctionKeyHourMinute.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ARConcepts.AvoidingRepetitionARCCoreEnumMemberAvoiding repetition, the overarching philosophy that inspired the rest of AgoRapide.
ARCQuery.FunctionKeyHourMinute.SyntaxHelpARCQueryClassMember'HourMinute()'
ARCCore.ARConcepts.AgoRapideHistoryARCCoreEnumMemberAgoRapide has roots back to 2011 when Bjørn Erling Fløtten invented panSL (SL = Schema language).
ARCQuery.FunctionKeyIntARCQueryClassRounds a double value to the nearest integer (uses .NET data type Int64 (long)).
ARCCore.ARConcepts.AdHocQueryARCCoreEnumMemberThe concept of a -Client- doing an ad-hoc query against (normally) a -ArmDB-.
ARCQuery.FunctionKeyInt.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ARConcepts.StandardAgoRapideCodeARCCoreEnumMemberCode originating from the main official AgoRapide distribution (which therefore does not include any end-application specific code)
ARCQuery.FunctionKeyInt.SyntaxHelpARCQueryClassMember'Int()'
ARCCore.ARConcepts.ApplicationSpecificCodeARCCoreEnumMemberCode specific for an end-application.
ARCQuery.FunctionKeyLengthARCQueryClassReturns length of (string) value of field, like 4 for 'John'.
ARCCore.ARConcepts.MemoryConsumptionARCCoreEnumMemberA naïve implementation of key-value storages like AgoRapide may lead to excessive memory (RAM) consumption.
ARCQuery.FunctionKeyLength.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ARConcepts.IndexingARCCoreEnumMemberIn-memory indexing of data is done 'behind-the-scenes' by some classes implementing -IP-.
ARCQuery.FunctionKeyLength.SyntaxHelpARCQueryClassMember'Length()'
ARCCore.ARConcepts.CoreDBSynchronizationARCCoreEnumMemberThe concept of how multiple -CoreDB- instances synchronizes their data.
ARCQuery.FunctionKeyMonthARCQueryClassExtracts month component from field like '2020-12-09' becoming '12'.
ARCCore.ARConcepts.SingleThreadedCodeARCCoreEnumMemberSome practical choices have been made in AgoRapide which requires object access to be done in a single-threaded manner, or within a locking context (using for instance -ReaderWriterLockSlim-).
ARCQuery.FunctionKeyMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ARConcepts.DataRetentionARCCoreEnumMemberThe concept of when to delete old data (if deemed necessary).
ARCQuery.FunctionKeyMonth.SyntaxHelpARCQueryClassMember'Month()'
ARCCore.ARConcepts.NoRealDeletionARCCoreEnumMemberAgoRapide has no real concept for deletion of data (apart from -DataRetention-, which is mostly relevant for 'old' data).
ARCQuery.FunctionKeyQuarterARCQueryClassExtracts quarter component from datetime field like '2020-12-09' becoming 'Q4'.
ARCCore.ARConcepts.ManyToManyRelationsARCCoreEnumMember-ARCQuery- supports many-to-many relations in a simple manner without introducing a third entity type (a third table).
ARCQuery.FunctionKeyQuarter.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCCore.ARConcepts.DocumentationARCCoreEnumMemberThanks to the tagging of enums and classes in AgoRapide (like this description), automatically generation of documentation is possible.
ARCQuery.FunctionKeyQuarter.SyntaxHelpARCQueryClassMember'Quarter()'
ARCCore.ARConcepts.AssertionsAndDetailedExceptionMessagesARCCoreEnumMemberThe abstraction level in AgoRapide is very high.
ARCQuery.FunctionKeyShortARCQueryClass'Smart' way of showing time. Removes unnecessary information.
ARCCore.ARConcepts.ExposingApplicationStateARCCoreEnumMemberThe traditional debugging process usually entails reading through logs and querying about your application state through a debugging tool.
ARCQuery.NewKey.TryParseSingleWordARCQueryClassMemberRecommended parser to use for functions without parameters.
ARCCore.Cardinality.WholeCollectionARCCoreEnumMemberValues are always set as a whole (there is no need or no meaning in setting or deleting individual items)
ARCQuery.NewKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCCore.Cardinality.IndividualItemsARCCoreEnumMemberValues are supposed to be set and 'deleted' individually.
ARCQuery.NewKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCCore.PSPrefixARCCoreEnumDescribes some recommended prefixes to use in a -PropertyStreamLine-.
ARCQuery.NewKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCCore.PSPrefix.dtARCCoreEnumMemberData, single key + value.
ARCQuery.NewKey.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCCore.PSPrefix.dtrARCCoreEnumMemberData, whole records.
ARCQuery.NewKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCCore.PSPrefix.RSARCCoreEnumMemberRS = Registration Stream (see -RegStream-).
ARCQuery.NewKey.ParsersARCQueryClassMemberInstances of all the relevant sub classes of -NewKey-.
ARCCore.PSPrefix.ESARCCoreEnumMemberES = Event Stream (see -EventStream-).
ARCQuery.NewKeyCountPARCQueryClassReturns the number of properties for a given entity object.
ARCCore.PSPrefix.cmdARCCoreEnumMemberCommand.
ARCQuery.NewKeyCountP.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCCore.PSPrefix.appARCCoreEnumMemberApplication state, like app/
ARCQuery.NewKeyCountP.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCCore.PSPrefix.docARCCoreEnumMemberDocumentation.
ARCQuery.NewKeyCountP.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCCore.PSPrefix.tARCCoreEnumMemberTranslations.
ARCQuery.NewKeyCountP.SyntaxHelpARCQueryClassMember'CountP()'
ARCCore.PKHTMLAttributePARCCoreEnumDescribes class -PKRelAttribute-.
ARCQuery.NewKeyCountP.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCCore.PKHTMLAttributeP.EncoderARCCoreEnumMemberThe class doing the HTML-encoding.
ARCQuery.NewKeyCountP.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCCore.PKLogAttributePARCCoreEnumDescribes class -PKLogAttribute.
ARCQuery.NewKeyCountPRecARCQueryClassReturns the number of properties for a given entity object.
ARCCore.PKLogAttributeP.DoNotLogAtAllARCCoreEnumMemberOriginates from -DoNotLogAtAll-.
ARCQuery.NewKeyCountPRec.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCCore.PKLogAttributeP.CountIntervalARCCoreEnumMemberFor a value of n, log only every n'th time the property is changed.
ARCQuery.NewKeyCountPRec.CountPRecARCQueryClassMemberCounts recursively the number of properties for a given entity object.
ARCCore.PP.VidARCCoreEnumMemberValidator id, that is entity which set -Valid- for this property.
ARCQuery.NewKeyCountPRec.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCCore.PP.InvalidARCCoreEnumMemberTimestamp when property was invalidated / 'deleted'.
ARCQuery.NewKeyCountPRec.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCCore.PP.IidARCCoreEnumMemberInvalidator id, that is entity which set -Invalid- for this property (or removed / 'undid' the invalidation by setting the value to '0001-01-01').
ARCQuery.NewKeyCountPRec.SyntaxHelpARCQueryClassMember'CountPRec()'
ARCCore.PP.ExceptionTextARCCoreEnumMemberGeneral property for logging of exceptions, usually set through -HandleException-.
ARCQuery.NewKeyCountPRec.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCCore.PConcurrentPARCCoreEnumDescribes class -PConcurrent-.
ARCQuery.NewKeyCountPRec.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCCore.PConcurrentP.HeartbeatARCCoreEnumMember 
ARCQuery.NewKeyGetTypeARCQueryClassReturns the internal C# object type of the given object.
ARCCore.ActualConnectionPARCCoreEnumDescribes class -ActualConnection-.
ARCQuery.NewKeyGetType.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCCore.ActualConnectionP.IdARCCoreEnumMemberWhen connection is used with-StreamProcessor-, the Id should be the same as the key used in the incoming / outgoing connection dictionary collection.
ARCQuery.NewKeyGetType.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCCore.ActualConnectionP.ConnectionInstructionARCCoreEnumMemberOnly relevant when we are an -Outgoing-.
ARCQuery.NewKeyGetType.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCCore.ActualConnectionP.ConnectionDirectionARCCoreEnumMember 
ARCQuery.NewKeyGetType.SyntaxHelpARCQueryClassMember'GetType()'
ARCCore.ActualConnectionP.CountReceiveMessageARCCoreEnumMember 
ARCQuery.NewKeyGetType.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCCore.ActualConnectionP.CountSendMessageARCCoreEnumMember 
ARCQuery.NewKeyGetType.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCCore.ActualConnectionP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCQuery.NewKeyToPropertyStreamARCQueryClassReturns the -PropertyStream- representation of the given object.
ARCCore.ActualConnectionP.SubscriptionAsRequestedByClientARCCoreEnumMemberOriginates from -Subscription-.
ARCQuery.NewKeyToPropertyStream.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCCore.ActualConnectionP.ClosingReasonARCCoreEnumMemberReason why this connection was closed
ARCQuery.NewKeyToPropertyStream.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCCore.ActualConnectionP.IsErrorConditionARCCoreEnumMemberSome kind of error condition has occured regarding data going back and forth, but the TCP/IP connection itself is probably sound.
ARCQuery.QueryExpressionCacheARCQueryClassDescribes if cache is to be used or not.
ARCCore.MultipleConnectionUsage.SimultaneousARCCoreEnumMemberThis connection to be used simultaneously with other connections with -Simultaneous-
ARCQuery.QueryExpressionCache.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCCore.StreamProcessorPARCCoreEnumDescribes class -StreamProcessor-.
ARCQuery.QueryExpressionCache.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCCore.StreamProcessorP.LocalStorageFolderARCCoreEnumMemberThe local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCQuery.QueryExpressionCache.SyntaxHelpARCQueryClassMemberCACHE {ON|OFF}
ARCCore.StreamProcessorP.IndividualStorageFileSizeARCCoreEnumMemberMax size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCQuery.QueryExpressionCommentARCQueryClassAllows insertion of SQL style comments (beginning with double hyphens / minus signs, '--') into queries.
ARCCore.StreamProcessorP.CurrentlyInitializingARCCoreEnumMemberSet to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCQuery.QueryExpressionComment.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCCore.StreamProcessorP.ClientUpdatePositionPathARCCoreEnumMemberComplete path to file containing -ClientUpdatePosition-.
ARCQuery.QueryExpressionComment.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCCore.StreamProcessorP.ClientUpdatePositionARCCoreEnumMemberNote how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCQuery.QueryExpressionComment.SyntaxHelpARCQueryClassMemberCOMMENT {comment text}
ARCCore.StreamProcessorP.IncomingConnectionsPortNoARCCoreEnumMemberIf not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.StreamProcessorP.UnderClosureARCCoreEnumMemberSet to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.StreamProcessorP.WriteToConsoleARCCoreEnumMemberIf true then incoming data (from other nodes will be written to console.
ARCCore.StreamProcessorP.TimestampARCCoreEnumMemberThe timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.StreamProcessorP.TimestampIsOldARCCoreEnumMemberA warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCCore.StreamProcessorP.TimestampResolutionARCCoreEnumMemberThe time interval between each timestamp update in the -PropertyStream-.
ARCCore.StreamProcessorP.DoNotStoreLocallyARCCoreEnumMemberFor -Client-, incoming data (as received from a -Outgoing-) is possible to store BOTH to disk, AND to (normally) a -PRich-.
ARCCore.StreamProcessorP.DoNotStoreLocalOriginLocallyARCCoreEnumMemberMeans 'do not store local origin locally but wait until it gets confirmed by core storage'.
ARCCore.StreamProcessorP.CacheDiskWritesARCCoreEnumMemberIf TRUE then will write the -PropertyStream- to disk in bigger chunks, thereby increasing performance.
ARCCore.StreamProcessorP.CopyFileStructureFromCoreARCCoreEnumMemberIf TRUE, will copy the exact file structure (through information given in -ClientUpdatePosition-).
ARCCore.StreamProcessorP.CountIncomingConnectionsARCCoreEnumMember 
ARCCore.StreamProcessorP.CountOutgoingConnectionsARCCoreEnumMember 
ARCCore.StreamProcessorP.CountOutsideLocalReceiverARCCoreEnumMemberCount of calls to -OutsideLocalReceiver-.
ARCCore.StreamProcessorP.CountReceiveLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- with -HasLocalOrigin-.
ARCCore.StreamProcessorP.CountReceiveNonLocalOriginARCCoreEnumMemberCount of -PropertyStreamLine- not with -HasLocalOrigin-.
ARCCore.StorageFilePARCCoreEnumDescribes class -StorageFile-.
ARCCore.StorageFileP.FilenameARCCoreEnumMember 
ARCCore.StorageFileP.HashARCCoreEnumMemberHash of storage file. Not implemented as of Apr 2020. It is envisaged to store hash-value as last line in storage file. In this case the hash must be the hash of the file excluding the last line
ARCCore.ConnectionDirectionARCCoreEnumThe concept of who took the initiative for the connections (who asked to open the TCP/IP session).
ARCCore.ConnectionDirection.IncomingARCCoreEnumMemberConnectionInstruction will not be set for these.
ARCCore.ConnectionDirection.OutgoingARCCoreEnumMemberThere would normally exist two live outgoing connection at a given point in time for -Client- / -ArmDB-:
ARCCore.DataTransferDirectionARCCoreEnumDirection for transfer of data.
ARCCore.DataTransferDirection.SendARCCoreEnumMemberLike -Client- sending in-application generated properties to -ArmDB- / -CoreDB- or -ArmDB- sending data received over an incoming connection to -CoreDB-.
ARCCore.DataTransferDirection.ReceiveARCCoreEnumMemberLike -Client- receiving data from an upstream -ArmDB- / -CoreDB- or -ArmDB- receiving data from an upstream -CoreDB-.
ARCCore.TPropertyKeyEnumARCCoreEnumPlaceholder for any enum type suitable as generic type parameter for -PExact-.
ARCDoc.DocFrag.ToHTMLSimpleSingleARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocFrag.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFrag.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocFrag.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragCollectionARCDocClassContains a collection of -DocFrag- objects.
ARCDoc.DocFragCollection.CreateARCDocClassMemberCreates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.DocFragCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFragCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocFragCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkARCDocClassDescribes to where a single HTML link points.
ARCDoc.DocLink.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLink.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocLink.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLink.LocationARCDocClassMemberCopy of -Location-.
ARCDoc.DocLink.FilenameARCDocClassMemberCopy of -LinkWordHTML-.
ARCDoc.DocLink.LinkWordHTMLARCDocClassMemberCopy of -LinkWordHTML-.
ARCDoc.DocLink.LinkWordHTMLWithHyphensARCDocClassMember-LinkWordHTML- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLink.LinkWordHTMLBeforeLtARCDocClassMemberIf -LinkWordHTML contains '<' (really '&lt;') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'.
ARCDoc.DocLink.LinkWordHTMLBeforeLtWithHyphensARCDocClassMember-LinkWordHTMLBeforeLt- with '-' (minus sign / hyphen) prepended and appended.
ARCDoc.DocLink.AHrefEndPartARCDocClassMember'Filename.Encoded + "> + LinkWordHTML + </a>'
ARCDoc.DocLinkCollectionARCDocClassContains a collection of -DocLink- objects.
ARCDoc.DocLinkCollection.CreateARCDocClassMemberNotes all locations and their positions in the hierarchical directory structure.
ARCDoc.DocLinkCollection.InsertLinks Overload1ARCDocClassMemberDoes -LinkInsertionInDocumentation- on the given HTML content.
ARCDoc.DocLinkCollection.InsertLinks Overload2ARCDocClassMemberSee overload with 'contentLocation' as parameter for documentation.
ARCDoc.DocLinkCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocLinkCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocLinkResolutionARCDocClassContains a resolution page for a link word which has duplicate 'targets' (pointing to multiple -DocLink- instances).
ARCDoc.DocLinkResolution.ToHTMLSimpleSingleARCDocClassMemberGives a friendly description about possible targets for LinkWord-.
ARCDoc.DocLinkResolution.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocLinkResolution.TryGetVARCDocClassMemberNote 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).
ARCDoc.DocLinkResolution.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.HLocation.ContentARCDocClassMemberThe Content object is not stored within the standard -IP--mechanism.
ARCDoc.HLocationCollectionARCDocClassContains a collection of -HLocation- objects.
ARCDoc.HLocationCollection.CreateARCDocClassMemberTransforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects.
ARCDoc.HLocationCollection.WriteAllContentHTMLToDiskARCDocClassMemberWrites all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-.
ARCDoc.HLocationCollection.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HLocationCollection.TryGetVARCDocClassMemberNote 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).
ARCDoc.HLocationCollection.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOCARCDocClassHTOC = Hierarchical table of contents.
ARCDoc.HTOC.CreateARCDocClassMemberStructures content hierarchically according to the criteria for each level.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload2ARCDocClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.HTOC.ToHTMLSimpleSingle Overload1ARCDocClassMemberUse this method in any class where a table-of-contents type of view is desireable
ARCDoc.HTOC.CreateInitialContentARCDocClassMemberHelper method for creation of a -FilterBranch-.
ARCDoc.HTOC.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.HTOC.TryGetVARCDocClassMemberNote 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).
ARCDoc.HTOC.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCDoc.HTOC.HTOCContentThisLevelKeyARCDocClassMemberThe key used for storing the actual content at this level.
ARCDoc.PKDocAttributeARCDocClassDescribes documentation and presentation of a property.
ARCDoc.PKDocAttribute.InitializeARCDocClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCDoc.PKDocAttribute.TryRemovePARCDocClassMemberShould probably never be used.
ARCDoc.PKDocAttribute.PriorityOrderARCDocClassMemberSee -PriorityOrder-.
ARCDoc.PKDocAttribute.IsDefaultARCDocClassMemberDoes 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.)
ARCDoc.UtilDocARCDocClassUtility methods for -ARCDoc-.
ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTMLARCDocClassMemberReturns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy.
ARCDoc.UtilDoc.GenerateHTMLPageARCDocClassMemberWraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS.
ARCDoc.UtilDoc.GlobalHeaderHTMLARCDocClassMemberGlobal header to be inserted at the top of every HTML page created by -GenerateHTMLPage-.
ARCDoc.HTOC+ParentChainARCDocClassUsed by -FilterNode- in order to keep track of node's parents.
ARCDoc.ApplePARCDocEnumDescribes class -Apple-.
ARCDoc.AppleP.NameARCDocEnumMemberThe name of the apple
ARCDoc.AppleP.ColourARCDocEnumMember 
ARCDoc.BananaPARCDocEnumDescribes class -Banana-.
ARCDoc.BananaP.NameARCDocEnumMemberThe name of the banana
ARCDoc.BananaP.ColourARCDocEnumMember 
ARCDoc.PriorityOrderARCDocEnumUsed for general sorting / prioritizing when showing properties for an entity.
ARCDoc.PriorityOrder.NotImportantARCDocEnumMember 
ARCDoc.PriorityOrder.ImportantARCDocEnumMember 
Assembly ARCQuery AssemblyARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.BinaryOperatorKeyARCQueryClassOffers expressions with operators like +, -, * and /.
ARCQuery.BinaryOperatorKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.BinaryOperatorKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.BinaryOperatorKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.BinaryOperatorKey.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.BinaryOperatorKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCQuery.CompoundInvalidKeyARCQueryClassUsed as a practical solution in order to know that a given key has been attemped parsed, but was not valid.
ARCQuery.CompoundInvalidKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.CompoundInvalidKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.CompoundInvalidKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.

Generated 2025-09-17 12:05:04.064 UTC