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

157 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
ARCAPI.BaseController.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
ARCAPI.BaseController.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.QueryExpressionTake.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.EntityMethodKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCAPI.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCQuery.UtilQuery.SplitOutsideOfARCQueryClassMemberEquivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCQuery.QueryExpressionTake.SyntaxHelpARCQueryClassMemberTAKE {Count}
ARCQuery.ForeignKeyARCQueryClassCan find related values, through compound field names.
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.UtilQuery.SpecialLinkPrefixesARCQueryClassMemberContains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.QueryExpressionThenByARCQueryClassAllows sorting by multiple columns.
ARCQuery.ForeignKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCQuery.ValueComparerARCQueryClassCan evaluation expressions like 'WHERE Created = ThisYear.
ARCQuery.QueryExpressionThenBy.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.ForeignKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.ValueComparer.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.QueryExpressionThenBy.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.ForeignKey.AllForeignKeysForEntityTypeARCQueryClassMemberReturns all possible foreign keys relevant for the given entity type, like for Order: 'Customer.FirstName' and 'Customer.LastName'.
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.ValueComparer.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.QueryExpressionThenBy.SyntaxHelpARCQueryClassMemberTHEN BY {key} [DESC] / [ASC]
ARCQuery.ForeignKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCQuery.ValueComparerDateTimeARCQueryClass-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.QueryExpressionTitleARCQueryClassThe title to be used in the final presentation of the query result.
ARCQuery.ForeignKey.StepsARCQueryClassMemberThe actual -ForeignKeySingleStep- leading to the -ForeignField-.
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.ValueComparerDateTime.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.QueryExpressionTitle.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.ForeignKey.StepsAreOnlyDirectionToOneARCQueryClassMemberIf TRUE then -TryGetPInternal) will use much simpler code without collections and parallell executions.
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.ValueComparerDateTime.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.QueryExpressionTitle.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.FunctionKeyLength.SyntaxHelpARCQueryClassMember'Length()'
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCQuery.ValueComparerDateTime.TryParseARCQueryClassMemberNote: This parser is probably exhaustive but not necessarily logical
ARCQuery.QueryExpressionTitle.SyntaxHelpARCQueryClassMemberTITLE {title}
ARCQuery.FunctionKeyMonthARCQueryClassExtracts month component from field like '2020-12-09' becoming '12'.
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.ValueComparerDateTime.ResolutionARCQueryClassMemberSee -ResolutionEnum-.
ARCQuery.QueryExpressionWhereARCQueryClassExecutes a 'WHERE {key} {operator} {value}' against the given collection.
ARCQuery.FunctionKeyMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.ValueComparerDateTime.StepsARCQueryClassMemberValue 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.QueryExpressionWhere.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.FunctionKeyMonth.SyntaxHelpARCQueryClassMember'Month()'
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
ARCQuery.ValueComparerDateTime.IsGlidingARCQueryClassMemberThe modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCQuery.QueryExpressionWhere.IsMatchARCQueryClassMemberReturns TRUE if property matches criteria.
ARCQuery.FunctionKeyQuarterARCQueryClassExtracts quarter component from datetime field like '2020-12-09' becoming 'Q4'.
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
ARCQuery.ValueComparerDateTime.IsBeforeARCQueryClassMemberThe modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCQuery.QueryExpressionWhere.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.FunctionKeyQuarter.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCQuery.ValueComparerDateTime.IsAfterARCQueryClassMemberThe modifier 'After' can be prepended in order to mean any time after the specified time.
ARCQuery.QueryExpressionWhere.SyntaxHelpARCQueryClassMemberWHERE {key} {operator} {value}
ARCQuery.FunctionKeyQuarter.SyntaxHelpARCQueryClassMember'Quarter()'
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCQuery.ValueComparerDateTime.IsIntervalARCQueryClassMemberNormally the interval which is compared against is the timespan corresponding to -Resolution-.
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.FunctionKeyShortARCQueryClass'Smart' way of showing time. Removes unnecessary information.
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCQuery.ValueComparerDateTime.InitValueARCQueryClassMemberFor debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-.
ARCQuery.QueryProgressARCQueryClassKeeps track of execution of query (that is, a query consisting of multiple -QueryExpression-), and also stores final result.
ARCQuery.FunctionKeyShort.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCQuery.ValueComparerDateTime.StartPeriodARCQueryClassMemberThe start of the interval which this instance compares against.
ARCQuery.QueryProgress.ToJSONSerializeableARCQueryClassMemberOverride of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCQuery.FunctionKeyShort.SyntaxHelpARCQueryClassMember'Short()'
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCQuery.ValueComparerDateTime.EndPeriodARCQueryClassMemberThe end of the interval which this instance compares against.
ARCQuery.QueryProgress.PreviousQueryJustExecutedARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.FunctionKeyTMBARCQueryClassTMB = Thousands, Millions, Billions.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCQuery.ValueComparerDateTime.ToDebugPropertiesARCQueryClassMemberExposes all members of this class.
ARCQuery.QueryProgress.NextQueryToExecuteARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.FunctionKeyTMB.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCQuery.ForeignKey+IKIPEqualityComparerARCQueryClassUsed by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys
ARCQuery.QueryProgress.ToHTMLSimpleSingleARCQueryClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.FunctionKeyTMB.SyntaxHelpARCQueryClassMember'TMB()'
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCQuery.ForeignKey+EntityTypeAndKeyARCQueryClassDescribes an entity type and a key.
ARCQuery.QueryProgress.OrderAndReconstructKeysARCQueryClassMemberPart 1:
ARCQuery.FunctionKeyTotalHoursARCQueryClassConverts a timespan to total hours (as an integer).
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCQuery.ForeignKey+EntityTypeAndKey.EntityTypeARCQueryClassMemberFor -IPRelationsKeysPointingTo-, corresponds to foreign entity type.
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryPartsARCQueryClassMemberIs able to generate the following:
ARCQuery.FunctionKeyTotalHours.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
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.QueryProgress.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.FunctionKeyTotalHours.SyntaxHelpARCQueryClassMember'TotalHours()'
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTermARCQueryClassMemberCorresponds to -PKRelAttributeP-.- OppositeTerm-.
ARCQuery.Quantile.OCTILEARCQueryEnumMemberDivide into 8 parts
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCQuery.Quantile.DECILEARCQueryEnumMemberDivide into 10 parts
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCQuery.Quantile.DUODECILEARCQueryEnumMemberDivide into 12 parts
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCQuery.Quantile.HEXADECILEARCQueryEnumMemberDivide into 16 parts
Assembly AgoBrowse Assembly 
ARCQuery.Quantile.VENTILEARCQueryEnumMemberDivide into 20 parts
AgoBrowse.ProgramAgoBrowseClass 
ARCQuery.Quantile.PERCENTILEARCQueryEnumMemberDivide into 100 parts
AgoBrowse.Program.InitStreamProcessorAgoBrowseClassMemberInitializes stream processor.
ARCQuery.Quantile.PERMILLEARCQueryEnumMemberDivide into 1000 parts
AgoBrowse.RootAgoBrowseClassContains the user friendly welcome text (front page) for the application.
ARCQuery.QueryProgressPARCQueryEnumDescribes class -QueryProgress-.
AgoBrowse.Root.ToHTMLSimpleSingleAgoBrowseClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryProgressP.TitleARCQueryEnumMemberThe title to be used in the final presentation of the query result.
AgoBrowse.Root.TryGetPAgoBrowseClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.QueryProgressP.QueriesARCQueryEnumMember 
AgoBrowse.Root.TryGetVAgoBrowseClassMemberNote 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.QueryProgressP.StrCurrentTypeARCQueryEnumMemberNormally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
AgoBrowse.Root.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
AgoBrowse.Controllers.CompileControllerAgoBrowseClassCompiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
AgoBrowse.Controllers.CompileController.APIMethodAgoBrowseClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
AgoBrowse.Controllers.CompileController.CompileAgoBrowseClassMemberCompiles a hierarchical 'picture book' from the given parameter.
ARCQuery.QueryProgressP.LinkAdjustmentARCQueryEnumMemberExperimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level).
AgoBrowse.Controllers.CompileController.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
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.
AgoBrowse.Controllers.ControllerFacadeAgoBrowseClassFacade for entry into the desired -RQController-.
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.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2AgoBrowseClassMemberCatches all HTTP GET requests to this API.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1AgoBrowseClassMemberCatches all HTTP POST requests to this API.
ARCQuery.TranslationsPARCQueryEnumThis enum has no values because the keys are the actual string to be translated.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.TranslationSinglePARCQueryEnumDescribes class -TranslationSingle-.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.TranslationSingleP.TextARCQueryEnumMember 
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
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.
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
Namespace AgoBrowse Namespace 
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
Namespace AgoBrowse.Controllers Namespace 
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-03 05:25:26.385 UTC