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

160 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCQuery.ForeignKey+ForeignKeySingleStepARCQueryClassDescribes how to traverse between related entities.
ARCAPI.AddController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.Quantile.OCTILEARCQueryEnumMemberDivide into 8 parts
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollectionARCQueryClassMemberThe collection containing all the (foreign) entities for the type that this step leads to
ARCAPI.AddController.AllowFilterARCAPIClassMemberDescribes what data is allowed to change through a list of -Subscription- instances.
ARCQuery.Quantile.DECILEARCQueryEnumMemberDivide into 10 parts
ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollectionARCQueryClassProvides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves.
ARCAPI.BaseControllerARCAPIClassContains basic functionality for serving API methods.
ARCQuery.Quantile.DUODECILEARCQueryEnumMemberDivide into 12 parts
ARCQuery.ForeignKeyDirectionARCQueryEnumDescribes the type of traversing to a foreign entity possible.
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCQuery.Quantile.HEXADECILEARCQueryEnumMemberDivide into 16 parts
ARCQuery.ForeignKeyDirection.ToOneARCQueryEnumMemberTraverse to one entity, like traversing from OrderLine to Order (based on OrderLine containing foreign key OrderId) or Order to Customer (based on Order containing foreign key CustomerId).
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.Quantile.VENTILEARCQueryEnumMemberDivide into 20 parts
ARCQuery.ForeignKeyDirection.ToManyARCQueryEnumMemberTraverse to many entities, like traversing from Customer to Order (based on Order containing foreign key CustomerId) or Order to OrderLine (based on OrderLine containing foreign key OrderId).
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
ARCQuery.Quantile.PERCENTILEARCQueryEnumMemberDivide into 100 parts
ARCQuery.AggregationTypeARCQueryEnumUsed by -QueryExpressionPivot- and -QueryExpressionAggregate-.
ARCAPI.BaseController.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
ARCQuery.Quantile.PERMILLEARCQueryEnumMemberDivide into 1000 parts
ARCQuery.AggregationType.CountARCQueryEnumMember 
ARCAPI.BaseController.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
ARCQuery.QueryProgressPARCQueryEnumDescribes class -QueryProgress-.
ARCQuery.AggregationType.SumARCQueryEnumMember 
ARCAPI.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCQuery.QueryProgressP.TitleARCQueryEnumMemberThe title to be used in the final presentation of the query result.
ARCQuery.RelationalOperatorARCQueryEnumRelational / comparision operators.
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressP.QueriesARCQueryEnumMember 
ARCQuery.RelationalOperator.EQARCQueryEnumMember 
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCQuery.QueryProgressP.StrCurrentTypeARCQueryEnumMemberNormally the -ToStringVeryShort- representation of the type of objects in the -Result- collection.
ARCQuery.RelationalOperator.CONTAINSARCQueryEnumMember 
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryProgressP.CurrentStrictnessARCQueryEnumMemberDescribes -Strictness- ON / OFF when executing query.
ARCQuery.RelationalOperator.NEQARCQueryEnumMember 
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgressP.CreateHintsARCQueryEnumMemberDescribes if hints are to be generated (as query progresses) for new queries.
ARCQuery.RelationalOperator.NOTCONTAINSARCQueryEnumMember 
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCQuery.QueryProgressP.UseCacheARCQueryEnumMemberDescribes if cache is to be used or not.
ARCQuery.RelationalOperator.GTARCQueryEnumMember 
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryProgressP.LinkAdjustmentARCQueryEnumMemberExperimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level).
ARCQuery.RelationalOperator.LTARCQueryEnumMember 
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: 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.
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.
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCQuery.TranslationsPARCQueryEnumThis enum has no values because the keys are the actual string to be translated.
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCQuery.TranslationSinglePARCQueryEnumDescribes class -TranslationSingle-.
Assembly AgoBrowse Assembly 
ARCQuery.TranslationSingleP.TextARCQueryEnumMember 
AgoBrowse.ProgramAgoBrowseClass 
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.
AgoBrowse.Program.InitStreamProcessorAgoBrowseClassMemberInitializes stream processor.
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
AgoBrowse.RootAgoBrowseClassContains the user friendly welcome text (front page) for the application.
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
AgoBrowse.Root.ToHTMLSimpleSingleAgoBrowseClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.EntityMethodKey+MethodType.ComplexARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
AgoBrowse.Root.TryGetPAgoBrowseClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCQuery.QueryExpressionWhere+WildcardPositionTypeARCQueryEnumPosition of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and
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.QueryExpressionWhere+WildcardPositionType.AtStartARCQueryEnumMemberExample: '*ABC'.
AgoBrowse.Root.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEndARCQueryEnumMemberExample: 'ABC*'.
AgoBrowse.Controllers.CompileControllerAgoBrowseClassCompiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEndARCQueryEnumMemberExample: '*ABC*'.
AgoBrowse.Controllers.CompileController.APIMethodAgoBrowseClassMemberThe (only) API method that this controller supports.
ARCQuery.QueryExpressionWhere+ValueEnumARCQueryEnumHelper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
AgoBrowse.Controllers.CompileController.CompileAgoBrowseClassMemberCompiles a hierarchical 'picture book' from the given parameter.
ARCQuery.QueryExpressionWhere+ValueEnum.NULLARCQueryEnumMember 
AgoBrowse.Controllers.CompileController.ToStringAgoBrowseClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULLARCQueryEnumMemberPractical value enabling suggestions from -GetPrevious- and -GetNext-.
AgoBrowse.Controllers.ControllerFacadeAgoBrowseClassFacade for entry into the desired -RQController-.
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.
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1AgoBrowseClassMemberCatches all HTTP POST requests to this API.
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.
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
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.
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
Namespace AgoBrowse Namespace 
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 
ARCDoc.OrangePARCDocEnumDescribes class -Orange-.
ARCDoc.OrangeP.NameARCDocEnumMemberThe name of the orange
ARCDoc.OrangeP.ColourARCDocEnumMember 
ARCDoc.SomeAppComponentPARCDocEnumDescribes class -SomeAppComponent-.
ARCDoc.SomeAppComponentP.SomeCountValueARCDocEnumMember 
ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLoggedARCDocEnumMember 
ARCDoc.DocFragPARCDocEnumDescribes class -DocFrag-.
ARCDoc.DocFragP.DocFragTypeARCDocEnumMember 
ARCDoc.DocLinkPARCDocEnumDescribes class -DocLink-.
ARCDoc.DocLinkP.LocationARCDocEnumMemberThe location that this link points to.
ARCDoc.DocLinkP.FilenameARCDocEnumMember 
ARCDoc.DocLinkP.LinkWordHTMLARCDocEnumMemberActual link as it is expected to occur in text, like '-MyCustomerClass&lt;T&gt;-'.
ARCDoc.DocLinkResolutionPARCDocEnumDescribes class -DocLinkResolution-
ARCDoc.DocLinkResolutionP.LinkWordARCDocEnumMember 
ARCDoc.DocLinkResolutionP.DocLinksARCDocEnumMemberThe possible links for -LinkWord-
ARCDoc.DocumentatorPARCDocEnumDescribes class -Documentator-.
ARCDoc.DummyEnumPARCDocEnumTODO: Document better what this is for (and change name)
ARCDoc.DummyEnumP._MemberInheritedARCDocEnumMemberContains not only members which are inherited in the object-oriented sense, but also overrides for which the only documentation was found in base class
ARCDoc.HLocationPARCDocEnumDescribes class -HLocation-.
ARCDoc.HLocationP.LocationARCDocEnumMemberFolder names / hierarchical levels.
ARCDoc.HLocationP.FilenameARCDocEnumMemberEither the last hierarhical key for the content's location, or Index.html if no location.
ARCDoc.HLocationP.ContentTypeARCDocEnumMemberThe type of the content object. The actual content object is stored as -Content-.
ARCDoc.PKDocAttributePARCDocEnumDescribes class -PKDocAttribute-.
ARCDoc.PKDocAttributeP.PriorityOrderARCDocEnumMemberUsed by -DescribeValue-.
ARCQuery.EntityMethodKey.AllEntityMethodKeysForEntityTypeDictARCQueryClassMemberReturns all -EntityMethodKey- in the class definition of the given entity type.
ARCQuery.EntityMethodKey.AllEntityMethodKeysForEntityTypeListARCQueryClassMemberReturns List sorted by Method Name of Value of Dictionary returned by -AllEntityMethodKeysForEntityTypeDict-
ARCQuery.EntityMethodKey.TryGetForeignFieldARCQueryClassMemberReturns foreign field through foreign key given.
ARCQuery.EntityMethodKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.EntityMethodKey.MethodARCQueryClassMemberThe actuall TryGet method implemented in the relevant entity class.
ARCQuery.EntityMethodKey.MethodNameAsIKARCQueryClassMemberName of TryGet method but without 'TryGet' in name
ARCQuery.EntityMethodKey.ReturnTypeARCQueryClassMemberThe type of the 'retval' out-parameter of the method.
ARCQuery.EntityMethodKey.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.EntityMethodKey.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCQuery.ForeignKeyARCQueryClassCan find related values, through compound field names.
ARCQuery.ForeignKey.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.ForeignKey.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.ForeignKey.AllForeignKeysForEntityTypeARCQueryClassMemberReturns all possible foreign keys relevant for the given entity type, like for Order: 'Customer.FirstName' and 'Customer.LastName'.
ARCQuery.ForeignKey.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.ForeignKey.StepsARCQueryClassMemberThe actual -ForeignKeySingleStep- leading to the -ForeignField-.
ARCQuery.ForeignKey.StepsAreOnlyDirectionToOneARCQueryClassMemberIf TRUE then -TryGetPInternal) will use much simpler code without collections and parallell executions.
ARCQuery.FunctionKeyAggregateMax.SyntaxHelpARCQueryClassMember'Max()'
ARCQuery.FunctionKeyAggregateMinARCQueryClassCalculates the minimum value of the given properties.
ARCQuery.FunctionKeyAggregateMin.SyntaxHelpARCQueryClassMember'Min()'
ARCQuery.FunctionKeyAggregateSingleARCQueryClassEnsures that the given list of properties contains only a single item and returns that item.
ARCQuery.FunctionKeyAggregateSingle.SyntaxHelpARCQueryClassMember'Single()'
ARCQuery.FunctionKeyAggregateSumARCQueryClassSums the given properties.
ARCQuery.FunctionKeyAggregateSum.SyntaxHelpARCQueryClassMember'Sum()'
ARCQuery.FunctionKeyARCQueryClassExtracts data from an already existing value like extracting Year from a DateTime in 'Created.Year()'.
ARCQuery.FunctionKey.TryGetP Overload1ARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKey.AddParserARCQueryClassMemberAdds a -ApplicationSpecificCode- parser.
ARCQuery.FunctionKey.TryParseARCQueryClassMemberFind parsers from -Parsers- based on first word in query.
ARCQuery.FunctionKey.TryParseSingleWordARCQueryClassMemberRecommended parser to use for functions without parameters.
ARCQuery.FunctionKey.TryGetP Overload2ARCQueryClassMemberOverload which will try to call -TryGetV- with generic type parameter, and if that does not succeed will try to call the optional 'tryParser'.
ARCQuery.FunctionKey.ParsersARCQueryClassMemberInstances of all the relevant sub classes of -FunctionKey-.
ARCQuery.FunctionKeyAbsARCQueryClassReturns the absolute value of field, like 4 for '-4'.
ARCQuery.FunctionKeyAbs.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.

Generated 2025-07-11 23:19:28.001 UTC