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

161 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
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.BaseController.GetTimestampIsOldWarningHTMLARCAPIClassMemberIf -TimestampIsOld- is found in the rootStorage-parameter, returns warning message in HTML format.
ARCQuery.QueryProgress.AdditionalJavascriptUrlEncoderARCQueryClassMemberReturns the Javascript code for converting characters that are difficult to pass in URLs to a format understood by -Decode-.
ARCQuery.QueryProgressP.AllLogEntriesForThisQueryARCQueryEnumMember 
ARCAPI.BaseController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.UtilQueryARCQueryClassUtility methods for -ARCQuery-.
ARCQuery.EntityMethodKey+MethodTypeARCQueryEnumExplains type of method signature found (trough reflection) for corresponding entity class.
ARCAPI.EditControllerARCAPIClassOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.
ARCQuery.UtilQuery.IndexOfOutsideOfARCQueryClassMemberEquivalent to string.IndexOf except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.EntityMethodKey+MethodType.SimpleARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)'
ARCAPI.EditController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.UtilQuery.IndexOfAnyOutsideOfARCQueryClassMemberEquivalent to string.IndexOfAny except that any character encountered inside pairs of the 'outsideOf'-char are not counted.
ARCQuery.EntityMethodKey+MethodType.ComplexARCQueryEnumMemberSignature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCAPI.EditController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.UtilQuery.SplitOutsideOfARCQueryClassMemberEquivalent to string.Split except that any character encountered inside pairs of the 'outsideOf'-char are not counted as separators.
ARCQuery.QueryExpressionWhere+ValueEnumARCQueryEnumHelper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
ARCAPI.GQControllerARCAPIClassOffers GraphQL queries.
ARCQuery.UtilQuery.SpecialLinkPrefixesARCQueryClassMemberContains prefixes for which links (see -LinkInsertionInDocumentation-) are also desired without the prefix.
ARCQuery.QueryExpressionWhere+ValueEnum.NULLARCQueryEnumMember 
ARCAPI.GQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.ValueComparerARCQueryClassCan evaluation expressions like 'WHERE Created = ThisYear.
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULLARCQueryEnumMemberPractical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCAPI.GQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.ValueComparer.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.QueryExpressionWhere+ValueEnum.ALLARCQueryEnumMemberEquivalent to query like WHERE Name = *
ARCAPI.RQControllerARCAPIClassRQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCQuery.ValueComparer.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.ValueComparerDateTime+ResolutionEnumARCQueryEnum 
ARCAPI.RQController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCQuery.ValueComparerDateTimeARCQueryClass-ValueComparerDateTime- is an attempt at offering a human language interface for date and time queries.
ARCQuery.ValueComparerDateTime+ResolutionEnum.SecondARCQueryEnumMember 
ARCAPI.RQController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.ValueComparerDateTime.TryGetPreviousARCQueryClassMemberSuggestion for previous query (browsing 'backwards')
ARCQuery.ValueComparerDateTime+ResolutionEnum.MinuteARCQueryEnumMember 
ARCAPI.DataStorageARCAPIClassThe all-in-memory global application data storage.
ARCQuery.ValueComparerDateTime.TryGetNextARCQueryClassMemberSuggestion for next query (browsing 'forwards')
ARCQuery.ValueComparerDateTime+ResolutionEnum.HourARCQueryEnumMember 
ARCAPI.DataStorage.CreateARCAPIClassMemberCreates a -DataStorage- instance with default parameters.
ARCQuery.ValueComparerDateTime.TryParseARCQueryClassMemberNote: This parser is probably exhaustive but not necessarily logical
ARCQuery.ValueComparerDateTime+ResolutionEnum.DayARCQueryEnumMember 
ARCAPI.DataStorage..ctorARCAPIClassMemberThis method will:
ARCQuery.ValueComparerDateTime.ResolutionARCQueryClassMemberSee -ResolutionEnum-.
ARCQuery.ValueComparerDateTime+ResolutionEnum.WeekARCQueryEnumMember 
ARCAPI.DataStorage.StorageARCAPIClassMemberThe actual storage.
ARCQuery.ValueComparerDateTime.StepsARCQueryClassMemberValue 0 would mean 'This', like ThisHour, Today, ThisMonth and so on.
ARCQuery.ValueComparerDateTime+ResolutionEnum.MonthARCQueryEnumMember 
ARCAPI.DataStorage.ControllerStorageARCAPIClassMemberUsually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCQuery.ValueComparerDateTime.IsGlidingARCQueryClassMemberThe modifier 'Gliding' (or just 'G') can be appended in order to mean continous gliding periode, so for instance
ARCQuery.ValueComparerDateTime+ResolutionEnum.QuarterARCQueryEnumMember 
ARCAPI.DataStorage.DocLinksARCAPIClassMemberNote that may be null.
ARCQuery.ValueComparerDateTime.IsBeforeARCQueryClassMemberThe modifier 'Before' can be prepended in order to mean from any time before the specified time.
ARCQuery.ValueComparerDateTime+ResolutionEnum.YearARCQueryEnumMember 
ARCAPI.DataStorage.LockARCAPIClassMemberLocking object for thread-safe access from simultaneous API requests.
ARCQuery.ValueComparerDateTime.IsAfterARCQueryClassMemberThe modifier 'After' can be prepended in order to mean any time after the specified time.
Assembly ARCAPI AssemblyA library providing an API on top of the -PropertyStream-.
ARCAPI.DataStorage.ExternalReceiverARCAPIClassMemberTypically used by -AddController-.
ARCQuery.ValueComparerDateTime.IsIntervalARCQueryClassMemberNormally the interval which is compared against is the timespan corresponding to -Resolution-.
ARCAPI.ContentResultARCAPIClassMimicks Microsoft.AspNetCore.Mvc.ContentResult.
ARCAPI.DataStorage.DoNotStoreInternallyARCAPIClassMemberTypically used by -AddController-.
ARCQuery.ValueComparerDateTime.InitValueARCQueryClassMemberFor debugging purposes. The initial 'now' value used before calculating -StartPeriod- and -EndPeriod-.
ARCAPI.ContentResult.CreateHTMLOKARCAPIClassMemberNOTE: Parameter must be a complete HTML page.
ARCAPI.BaseControllerPARCAPIEnumDescribes class -BaseController-.
ARCQuery.ValueComparerDateTime.StartPeriodARCQueryClassMemberThe start of the interval which this instance compares against.
ARCAPI.ContentResult.CreateErrorARCAPIClassMemberTODO: Add a key / value format for error messages, like done for -Log-.
ARCAPI.BaseControllerP.CountRequestARCAPIEnumMemberNumber of calls to -APIMethod- since application initialization
ARCQuery.ValueComparerDateTime.EndPeriodARCQueryClassMemberThe end of the interval which this instance compares against.
ARCAPI.AddControllerARCAPIClassParses and stores a -PropertyStreamLine-.
ARCAPI.BaseControllerP.CountExceptionARCAPIEnumMemberNumber of exceptions at call to -APIMethod- since application initialization
ARCQuery.ValueComparerDateTime.ToDebugPropertiesARCQueryClassMemberExposes all members of this class.
ARCAPI.AddController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
ARCAPI.BaseControllerP.LogLevelARCAPIEnumMember 
ARCQuery.ForeignKey+IKIPEqualityComparerARCQueryClassUsed by -TryGetPInternal- when it needs distinct list of foreign entities, based on their keys
ARCAPI.AddController.ToStringARCAPIClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCAPI.ResponseFormatARCAPIEnumThe response format, HTML or JSON, for an API request.
ARCQuery.ForeignKey+ForeignKeySingleStepARCQueryClass 
ARCAPI.AddController.AllowFilterARCAPIClassMemberDescribes what data is allowed to change through a list of -Subscription- instances.
ARCAPI.ResponseFormat.JSONARCAPIEnumMember 
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignTypeARCQueryClassMemberThe foreign type.
ARCAPI.BaseControllerARCAPIClassContains basic functionality for serving API methods.
ARCAPI.ResponseFormat.HTMLARCAPIEnumMember 
ARCQuery.ForeignKey+ForeignKeySingleStep.ActualForeignKeyARCQueryClassMemberThe actual foreign key like OrderId or CustomerId to use for this step
ARCAPI.BaseController.BuildControllerStorageARCAPIClassMemberBuilds a collection of 'std' (standard) controller instances to use for serving API requests.
Assembly AgoMail Assembly 
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesARCQueryClassMemberThe collection containing all the (foreign) entities for the type that this step leads to
ARCAPI.BaseController.APIMethodARCAPIClassMemberThe (only) API method that this controller supports.
AgoMail.CleanerAgoMailClass 
ARCQuery.ForeignKeyDirectionARCQueryEnumDescribes the type of traversing to a foreign entity possible.
ARCAPI.BaseController.CatchAllARCAPIClassMemberServes the typical single generic API method in an AgoRapide API.
AgoMail.Cleaner.CleanAgoMailClassMemberRemoves emails with often seen values for Subject, To or From.
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.TryNavigateToLevelInDataStorageARCAPIClassMemberNavigates to the specified level (usually within -Storage-).
AgoMail.EmailAgoMailClass 
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.GetFormatAndAdjustRequestARCAPIClassMemberDecides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
AgoMail.Email.TryGetVAgoMailClassMemberNote 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).
AgoMail.Controllers.ControllerFacade.CatchAll Overload2AgoMailClassMemberCatches all HTTP GET requests to this API.
AgoMail.Controllers.ControllerFacade.CatchAll Overload1AgoMailClassMemberCatches all HTTP POST requests to this API.
AgoMail.EmailPAgoMailEnum 
AgoMail.EmailP.DateAgoMailEnumMemberUTC-format
AgoMail.EmailP.FromAgoMailEnumMember 
AgoMail.EmailP.ToAgoMailEnumMember 
AgoMail.EmailP.CCAgoMailEnumMember 
AgoMail.EmailP.SubjectAgoMailEnumMember 
AgoMail.EmailP.TextBodyAgoMailEnumMember 
AgoMail.EmailP.HTMLBodyAgoMailEnumMember 
AgoMail.EmailP.HeadersAgoMailEnumMember 
AgoMail.EmailP.AttachmentsAgoMailEnumMember 
Namespace ARCCore NamespaceA necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
Namespace ARCDoc NamespaceA library supporting documentation and demonstrating usage of AgoRapide.
Namespace ARCQuery NamespaceARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
Namespace ARCAPI NamespaceA library providing an API on top of the -PropertyStream-.
Namespace AgoMail Namespace 
Namespace AgoMail.Controllers Namespace 
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.FunctionKeyDateARCQueryClassFormats a date without time component.
ARCQuery.FunctionKeyDate.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.FunctionKeyDate.SyntaxHelpARCQueryClassMember'Date()'
ARCQuery.FunctionKeyDayOfWeekARCQueryClassExtracts DayOfWeek from field like 'Monday', 'Tuesday' and so on.
ARCQuery.FunctionKeyDayOfWeek.TryGetPARCQueryClassMemberNOTE: The in-parameter is a property, not an entity.
ARCQuery.NewKeyCountP.FunctionKeysARCQueryClassMemberAll -FunctionKey-s chained at end of compound key (but before an eventual -QuantileKey-).
ARCQuery.NewKeyCountP.QuantileKeyARCQueryClassMemberEventual final -QuantileKey- at end of compound key.
ARCQuery.NewKeyCountPRecARCQueryClassReturns the number of properties for a given entity object.
ARCQuery.NewKeyCountPRec.TryGetPInternalARCQueryClassMemberThe internal executor, containing the specific functionality for how to evaluate the key.
ARCQuery.NewKeyCountPRec.CountPRecARCQueryClassMemberCounts recursively the number of properties for a given entity object.
ARCQuery.NewKeyCountPRec.ToStringARCQueryClassMemberThe ToString representation is the one relevant when used as key, like in -IK- or when selecting like 'SELECT {fieldName}'.
ARCQuery.NewKeyCountPRec.TryGetPARCQueryClassMemberThe outwards facing executor, understanding use of -FunctionKeys-.
ARCQuery.NewKeyCountPRec.SyntaxHelpARCQueryClassMember'CountPRec()'
ARCQuery.QueryExpressionOrderBy.KeyARCQueryClassMemberTODO: Expand syntax to include multiple keys
ARCQuery.QueryExpressionPivotARCQueryClassCreates a table by querying over two keys like
ARCQuery.QueryExpressionPivot.ExecuteARCQueryClassMemberTransforms the given input collection into a resulting collection.
ARCQuery.QueryExpressionPivot.GetCrossSummationCheckerARCQueryClassMemberReturns a cross sum checker for int, long, double, Timespan.
ARCQuery.QueryExpressionPivot.TryCheckForExistenceOfKeyARCQueryClassMemberUsed by query expressions in order to catch wrong field names used or misspelling of field names.
ARCQuery.QueryExpressionPivot.SyntaxHelpARCQueryClassMember1) 'PIVOT {rowKey} BY {columnKey}' like "PIVOT Colour BY Production.Year"
ARCQuery.QueryExpressionPivot.AggregationTypeARCQueryClassMemberMost common value is -Count-, in which case -AggregationKey- may be correspondingly set to null.
ARCQuery.QueryExpressionPivot.AggregationKeyARCQueryClassMemberThis is often null (with -AggregationType- correspondingly set to Count-).
ARCQuery.QueryProgress.ToJSONSerializeableARCQueryClassMemberOverride of default interface method -ToJSONSerializeable- is necessary because resulting data is 'hidden' within -Result-.
ARCQuery.QueryProgress.PreviousQueryJustExecutedARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.QueryProgress.NextQueryToExecuteARCQueryClassMemberTODO: This is somewhat loosely associated.
ARCQuery.QueryProgress.ToHTMLSimpleSingleARCQueryClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.QueryProgress.OrderAndReconstructKeysARCQueryClassMemberPart 1:
ARCQuery.QueryProgress.GetHTMLLinksToIndividualQueryPartsARCQueryClassMemberIs able to generate the following:
ARCQuery.QueryProgress.ToStringARCQueryClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCQuery.QueryProgress.ResultARCQueryClassMemberThis gets updated continously as the different query expressions get evaluated.
ARCQuery.Quantile.PERMILLEARCQueryEnumMemberDivide into 1000 parts
ARCQuery.QueryProgressPARCQueryEnumDescribes class -QueryProgress-.
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.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.
AgoMail.Email.ToStringAgoMailClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoMail.ProgramAgoMailClassApplication startup and initialization
AgoMail.Program.InitStreamProcessorAgoMailClassMemberInitializes stream processor.
AgoMail.RootAgoMailClassContains the user friendly welcome text (front page) for the application.
AgoMail.Root.ToHTMLSimpleSingleAgoMailClassMemberAlternative ('override') to -ToHTMLSimpleSingle-.
AgoMail.Root.TryGetVAgoMailClassMemberNote 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).
AgoMail.Root.ToStringAgoMailClassMemberTODO: Decide on what we actually want with ToString for this class.
AgoMail.Controllers.ControllerFacadeAgoMailClassFacade for entry into the desired -BaseController-.

Generated 2026-11-04 08:35:00.646 UTC