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

137 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
ARCDoc.HLocationARCDocClassSimple class describing the location of a single -IP- instance within some hierarhical context.
ARCQuery.RelationalOperator.NEQARCQueryEnumMember 
ARCAPI.ContentResult.CreateHTMLOKARCAPIClassMemberNOTE: Parameter must be a complete HTML page.
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
ARCDoc.HLocation.TryGetPARCDocClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.RelationalOperator.NOTCONTAINSARCQueryEnumMember 
ARCAPI.ContentResult.CreateErrorARCAPIClassMemberTODO: Add a key / value format for error messages, like done for -Log-.
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
ARCDoc.HLocation.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).
ARCQuery.RelationalOperator.GTARCQueryEnumMember 
ARCAPI.AddControllerARCAPIClassParses and stores a -PropertyStreamLine-.
ARCQuery.QueryProgressP.LinkAdjustmentARCQueryEnumMemberExperimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level).
ARCDoc.HLocation.ToStringARCDocClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.RelationalOperator.LTARCQueryEnumMember 
ARCAPI.AddController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
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.FunctionKeyTotalMinutesARCQueryClassConverts a timespan to total minutes (as an integer).
ARCQuery.RelationalOperator.GEQARCQueryEnumMember 
ARCAPI.AddController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
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.FunctionKeyTotalMinutes.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.RelationalOperator.LEQARCQueryEnumMember 
ARCAPI.AddController.AllowFilterARCAPIClassMemberDescribes what data is allowed to change through a list of -Subscription- instances.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
ARCQuery.FunctionKeyTotalMinutes.SyntaxHelpARCQueryClassMember'TotalMinutes()'
ARCQuery.RelationalOperator.LIKEARCQueryEnumMemberCase sensitive string wildcard comparision.
ARCAPI.BaseControllerARCAPIClassContains basic functionality for serving API methods.
ARCQuery.TranslationsPARCQueryEnumThis enum has no values because the keys are the actual string to be translated.
ARCQuery.FunctionKeyTypeARCQueryClassReturns the type of a property.
ARCQuery.RelationalOperator.ILIKEARCQueryEnumMemberCase insensitive string wildcard comparision.
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCQuery.TranslationSinglePARCQueryEnumDescribes class -TranslationSingle-.
ARCQuery.FunctionKeyType.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.RelationalOperator.NOTLIKEARCQueryEnumMemberCase sensitive string wildcard comparision.
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.TranslationSingleP.TextARCQueryEnumMember 
ARCQuery.FunctionKeyType.SyntaxHelpARCQueryClassMember'Type()'
ARCQuery.RelationalOperator.NOTILIKEARCQueryEnumMemberCase insensitive string wildcard comparision.
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
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.FunctionKeyWeekARCQueryClassExtract week-number from field according to ISO 8601.
ARCQuery.StrictnessARCQueryEnumDescribes level of -Strictness- when executing query.
ARCAPI.BaseController.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
ARCQuery.FunctionKeyWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.Strictness.ONARCQueryEnumMember 
ARCAPI.BaseController.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCQuery.FunctionKeyWeek.SyntaxHelpARCQueryClassMember'Week()'
ARCQuery.Strictness.OFFARCQueryEnumMember 
ARCAPI.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCQuery.EntityMethodKey+MethodType.ComplexARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCQuery.FunctionKeyYearARCQueryClassExtracts Year-component from field.
ARCQuery.QuantileARCQueryEnumDescribes quantiles like -TERTILE- and -QUARTILE-.
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+WildcardPositionTypeARCQueryEnumPosition of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and
ARCQuery.FunctionKeyYear.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.Quantile.MEDIANARCQueryEnumMemberDivide into two parts
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartARCQueryEnumMemberExample: '*ABC'.
ARCQuery.FunctionKeyYear.SyntaxHelpARCQueryClassMember'Year()'
ARCQuery.Quantile.TERTILEARCQueryEnumMemberDivide into three parts
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEndARCQueryEnumMemberExample: 'ABC*'.
ARCQuery.FunctionKeyYearMonthARCQueryClassExtracts Year + Month component from field like 2020-06.
ARCQuery.Quantile.QUARTILEARCQueryEnumMemberDivide into four parts
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEndARCQueryEnumMemberExample: '*ABC*'.
ARCQuery.FunctionKeyYearMonth.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.Quantile.QUINTILEARCQueryEnumMemberDivide into five parts
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
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.FunctionKeyYearMonth.SyntaxHelpARCQueryClassMember'YearMonth()'
ARCQuery.Quantile.SEXTILEARCQueryEnumMemberDivide into 6 parts
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryExpressionWhere+ValueEnum.NULLARCQueryEnumMember 
ARCQuery.FunctionKeyYearQuarterARCQueryClassExtracts Year + Quarter component from field like 2020Q1.
ARCQuery.Quantile.SEPTILEARCQueryEnumMemberDivide into 7 parts
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULLARCQueryEnumMemberPractical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCQuery.Query.ShouldTerminateARCQueryClassMemberAttempts to explain problem, in -TerminateReason- and by logging.
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2AgoBrowseClassMemberCatches all HTTP GET requests to this API.
ARCQuery.Query.ExecuteOneARCQueryClassMemberNOTE: Note how avoids deferred execution in order to always correctly time execution of each query element separately.
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1AgoBrowseClassMemberCatches all HTTP POST requests to this API.
ARCQuery.Query.AllLogEntriesForThisQueryARCQueryClassMemberTemporary storage of log information.
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
ARCQuery.Query.ProgressARCQueryClassMemberUse of member class in order for -Query- not to inherit -IP-.
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
ARCQuery.QueryExpressionARCQueryClassRepresents part of a query (or actually a transformation) against a given collection and the data storage from which it was taken.
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCQuery.QueryExpression.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCQuery.QueryExpression.AddParserARCQueryClassMemberAdds a -ApplicationSpecificCode- parser.
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
Namespace AgoBrowse Namespace 
ARCQuery.QueryExpression.TryParseARCQueryClassMemberFind parsers from -Parsers- based on first word in query.
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
Namespace AgoBrowse.Controllers Namespace 
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
Assembly AgoBrowse Assembly 
AgoBrowse.ProgramAgoBrowseClass 
AgoBrowse.Program.InitStreamProcessorAgoBrowseClassMemberInitializes stream processor.
AgoBrowse.RootAgoBrowseClassContains the user friendly welcome text (front page) for the application.
AgoBrowse.Root.ToHTMLSimpleSingleAgoBrowseClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
AgoBrowse.Root.TryGetPAgoBrowseClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
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).
AgoBrowse.Root.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.CompileControllerAgoBrowseClassCompiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
AgoBrowse.Controllers.CompileController.APIMethodAgoBrowseClassMemberThe (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.CompileAgoBrowseClassMemberCompiles a hierarchical 'picture book' from the given parameter.
AgoBrowse.Controllers.CompileController.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.ControllerFacadeAgoBrowseClassFacade for entry into the desired -RQController-.
ARCQuery.QueryExpression.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpression.ParsersARCQueryClassMemberParsers for all the relevant sub classes of -QueryExpression-.
ARCQuery.QueryExpressionWithSuggestionsARCQueryClassKeeps track as each query item gets executed.
ARCQuery.QueryExpressionWithSuggestions.PreviousARCQueryClassMemberSuggestion for a 'browse backwards' button.
ARCQuery.QueryExpressionWithSuggestions.NextARCQueryClassMemberSuggestion for a 'browse forwards' button.
ARCQuery.QueryExpressionAggregateARCQueryClassAggregates over the given key.
ARCQuery.QueryExpressionAggregate.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionAggregate.IsSuitableAggregatorARCQueryClassMemberReturns true if

Generated 2025-07-10 00:40:52.771 UTC