[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   SKIP 1032   

145 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
AgoBrowse.Controllers.CompileController.CompileAgoBrowseClassMemberCompiles a hierarchical 'picture book' from the given parameter.
ARCQuery.CompoundInvalidKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.QueryExpressionComment.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
AgoBrowse.Controllers.CompileController.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.CompoundInvalidKey.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.QueryExpressionComment.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
AgoBrowse.Controllers.ControllerFacadeAgoBrowseClassFacade for entry into the desired -RQController-.
ARCQuery.CompoundInvalidKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCQuery.QueryExpressionComment.SyntaxHelpARCQueryClassMemberCOMMENT {comment text}
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2AgoBrowseClassMemberCatches all HTTP GET requests to this API.
ARCQuery.CompoundKeyARCQueryClassA class able to expand the concept of entity keys.
ARCQuery.QueryExpressionTitle.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1AgoBrowseClassMemberCatches all HTTP POST requests to this API.
ARCQuery.CompoundKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.QueryExpressionTitle.SyntaxHelpARCQueryClassMemberTITLE {title}
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.CompoundKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.QueryExpressionWhereARCQueryClassExecutes a 'WHERE {key} {operator} {value}' against the given collection.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.CompoundKey.ParseARCQueryClassMemberNote that no TryParse is offered here, because Parse will always succeed (it just returns -CompoundInvalidKey- if 'fails').
ARCQuery.QueryExpressionWhere.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.CompoundKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.QueryExpressionWhere.IsMatchARCQueryClassMemberReturns TRUE if property matches criteria.
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCQuery.CompoundKey.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
Namespace AgoBrowse Namespace 
ARCQuery.CompoundKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCQuery.QueryExpressionWhere.SyntaxHelpARCQueryClassMemberWHERE {key} {operator} {value}
Namespace AgoBrowse.Controllers Namespace 
ARCQuery.ConstantKey<T>ARCQueryClassRepresents a constant expression like "' '", "', '", "42".
ARCQuery.QueryExpressionWhere.ValueARCQueryClassMemberThe Value should ideally be as strongly typed as possible. Note that it may be of type -ValueEnum- relevant for queries like WHERE Name = NULL.
ARCQuery.ConstantKey<T>.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.QueryProgressARCQueryClassKeeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
ARCQuery.ConstantKey<T>.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.QueryProgress.ToJSONSerializeableARCQueryClassMemberOverride of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCQuery.ConstantKey<T>.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.QueryProgress.PreviousQueryJustExecutedARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.ConstantKey<T>.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.QueryProgress.NextQueryToExecuteARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.ConstantKey<T>.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCQuery.QueryProgress.ToHTMLSimpleSingleARCQueryClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.EntityMethodKeyARCQueryClassKey able to call read-only methods defined in the entity class with names like 'TryGet{FieldName}'.
ARCQuery.QueryProgress.OrderAndReconstructKeysARCQueryClassMemberPart 1:
ARCQuery.EntityMethodKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryPartsARCQueryClassMemberIs able to generate the following:
ARCQuery.EntityMethodKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.QueryProgress.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyLength.SyntaxHelpARCQueryClassMember'Length()'
ARCQuery.ValueComparerDateTime.TryParseARCQueryClassMemberNote: This parser is probably exhaustive but not necessarily logical
ARCQuery.FunctionKeyMonthARCQueryClassExtracts month component from field like '2020-12-09' becoming '12'.
ARCQuery.ValueComparerDateTime.ResolutionARCQueryClassMemberSee -ResolutionEnum-.
ARCQuery.FunctionKeyMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.ValueComparerDateTime.StepsARCQueryClassMemberValue 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.FunctionKeyMonth.SyntaxHelpARCQueryClassMember'Month()'
ARCQuery.ValueComparerDateTime.IsGlidingARCQueryClassMemberThe modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCQuery.FunctionKeyQuarterARCQueryClassExtracts quarter component from datetime field like '2020-12-09' becoming 'Q4'.
ARCQuery.ValueComparerDateTime.IsBeforeARCQueryClassMemberThe modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCQuery.FunctionKeyQuarter.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.ValueComparerDateTime.IsAfterARCQueryClassMemberThe modifier 'After' can be prepended in order to mean any time after the specified time.
ARCQuery.FunctionKeyQuarter.SyntaxHelpARCQueryClassMember'Quarter()'
ARCQuery.ValueComparerDateTime.IsIntervalARCQueryClassMemberNormally the interval which is compared against is the timespan corresponding to -Resolution-.
ARCQuery.FunctionKeyShortARCQueryClass'Smart' way of showing time. Removes unnecessary information.
ARCQuery.ValueComparerDateTime.InitValueARCQueryClassMemberFor debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-.
ARCQuery.FunctionKeyShort.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.ValueComparerDateTime.StartPeriodARCQueryClassMemberThe start of the interval which this instance compares against.
ARCQuery.FunctionKeyShort.SyntaxHelpARCQueryClassMember'Short()'
ARCQuery.ValueComparerDateTime.EndPeriodARCQueryClassMemberThe end of the interval which this instance compares against.
ARCQuery.FunctionKeyTMBARCQueryClassTMB = Thousands, Millions, Billions.
ARCQuery.ValueComparerDateTime.ToDebugPropertiesARCQueryClassMemberExposes all members of this class.
ARCQuery.FunctionKeyTMB.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.ForeignKey+IKIPEqualityComparerARCQueryClassUsed by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys
ARCQuery.FunctionKeyTMB.SyntaxHelpARCQueryClassMember'TMB()'
ARCQuery.ForeignKey+EntityTypeAndKeyARCQueryClassDescribes an entity type and a key.
ARCQuery.FunctionKeyTotalHoursARCQueryClassConverts a timespan to total hours (as an integer).
ARCQuery.ForeignKey+EntityTypeAndKey.EntityTypeARCQueryClassMemberFor -IPRelationsKeysPointingTo-, corresponds to foreign entity type.
ARCQuery.FunctionKeyTotalHours.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.ForeignKey+EntityTypeAndKey.KeyARCQueryClassMemberNOTE: Key in EntityTypeAndKey was relaxed from PK to IK 25 Feb 2022 in order for experiment in -ForeignKey- to work.
ARCQuery.FunctionKeyTotalHours.SyntaxHelpARCQueryClassMember'TotalHours()'
ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTermARCQueryClassMemberCorresponds to -PKRelAttributeP-.- OppositeTerm-.
ARCQuery.FunctionKeyTotalMinutesARCQueryClassConverts a timespan to total minutes (as an integer).
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCQuery.FunctionKeyTotalMinutes.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelpARCQueryClassMember'TotalMinutes()'
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyTypeARCQueryClassReturns the type of a property.
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
ARCQuery.FunctionKeyType.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
ARCQuery.FunctionKeyType.SyntaxHelpARCQueryClassMember'Type()'
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCQuery.FunctionKeyWeekARCQueryClassExtract week-number from field according to ISO 8601.
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCQuery.FunctionKeyWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCQuery.FunctionKeyWeek.SyntaxHelpARCQueryClassMember'Week()'
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCQuery.FunctionKeyYearARCQueryClassExtracts Year-component from field.
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCQuery.FunctionKeyYear.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCQuery.FunctionKeyYear.SyntaxHelpARCQueryClassMember'Year()'
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCQuery.FunctionKeyYearMonthARCQueryClassExtracts Year + Month component from field like 2020-06.
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCQuery.FunctionKeyYearMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCQuery.FunctionKeyYearMonth.SyntaxHelpARCQueryClassMember'YearMonth()'
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCQuery.FunctionKeyYearQuarterARCQueryClassExtracts Year + Quarter component from field like 2020Q1.
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCQuery.Quantile.OCTILEARCQueryEnumMemberDivide into 8 parts
ARCQuery.Quantile.DECILEARCQueryEnumMemberDivide into 10 parts
ARCQuery.Quantile.DUODECILEARCQueryEnumMemberDivide into 12 parts
ARCQuery.Quantile.HEXADECILEARCQueryEnumMemberDivide into 16 parts
ARCQuery.Quantile.VENTILEARCQueryEnumMemberDivide into 20 parts
ARCQuery.Quantile.PERCENTILEARCQueryEnumMemberDivide into 100 parts
ARCQuery.Quantile.PERMILLEARCQueryEnumMemberDivide into 1000 parts
ARCQuery.QueryProgressPARCQueryEnumDescribes class -QueryProgress-.
ARCQuery.QueryProgressP.TitleARCQueryEnumMemberThe title to be used in the final presentation of the query result.
ARCQuery.QueryProgressP.QueriesARCQueryEnumMember 
ARCQuery.QueryProgressP.StrCurrentTypeARCQueryEnumMemberNormally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
ARCQuery.QueryProgressP.LinkAdjustmentARCQueryEnumMemberExperimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level).
ARCQuery.QueryProgressP.LimitARCQueryEnumMemberLimits the final HTML presentation of results (limits the number of elements being presented). Does not affect the query in itself. Used in order to avoid building huge HTML pages which will not be consumed anyway.
ARCQuery.QueryProgressP.TerminateReasonARCQueryEnumMemberThe reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
ARCQuery.TranslationsPARCQueryEnumThis enum has no values because the keys are the actual string to be translated.
ARCQuery.TranslationSinglePARCQueryEnumDescribes class -TranslationSingle-.
ARCQuery.TranslationSingleP.TextARCQueryEnumMember 
ARCQuery.TranslationSingleP.IsMissingARCQueryEnumMemberValue TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing.
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCQuery.EntityMethodKey+MethodType.ComplexARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCQuery.QueryExpressionWhere+WildcardPositionTypeARCQueryEnumPosition of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartARCQueryEnumMemberExample: '*ABC'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEndARCQueryEnumMemberExample: 'ABC*'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEndARCQueryEnumMemberExample: '*ABC*'.
ARCQuery.QueryExpressionWhere+ValueEnumARCQueryEnumHelper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
ARCQuery.QueryExpressionWhere+ValueEnum.NULLARCQueryEnumMember 
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULLARCQueryEnumMemberPractical value enabling suggestions from -GetPrevious- and -GetNext-.

Generated 2026-07-02 22:33:01.364 UTC