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

155 items

DocFragId	Assembly	DocFragType	Description.FirstLine()
ARCAPI.GQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.ForeignKey+EntityTypeAndKey.OppositeTerm	ARCQuery	ClassMember	Corresponds to -PKRelAttributeP-.- OppositeTerm-.
ARCAPI.GQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.ForeignKey+ForeignKeySingleStep	ARCQuery	Class	Describes how to traverse between related entities.
ARCAPI.RQController	ARCAPI	Class	RQ = REST Query. Executes a REST like query request against the given -DataStorage-.
ARCQuery.ForeignKey+ForeignKeySingleStep.ForeignEntitiesCollection	ARCQuery	ClassMember	The collection containing all the (foreign) entities for the type that this step leads to
ARCAPI.RQController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCQuery.QueryExpressionSelfCreate+ISelfCreateCollection	ARCQuery	Class	Provides a standardized mechanism for describing classes that are able to autogenerate collection of themeselves.
ARCAPI.RQController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCQuery.ForeignKeyDirection	ARCQuery	Enum	Describes the type of traversing to a foreign entity possible.
ARCAPI.DataStorage	ARCAPI	Class	The all-in-memory global application data storage.
ARCQuery.ForeignKeyDirection.ToOne	ARCQuery	EnumMember	Traverse 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.DataStorage.Create	ARCAPI	ClassMember	Creates a -DataStorage- instance with default parameters.
ARCQuery.ForeignKeyDirection.ToMany	ARCQuery	EnumMember	Traverse 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.DataStorage..ctor	ARCAPI	ClassMember	This method will:
ARCQuery.AggregationType	ARCQuery	Enum	Used by -QueryExpressionPivot- and -QueryExpressionAggregate-.
ARCAPI.DataStorage.Storage	ARCAPI	ClassMember	The actual storage.
ARCQuery.AggregationType.Count	ARCQuery	EnumMember
ARCAPI.DataStorage.ControllerStorage	ARCAPI	ClassMember	Usually (but not always) a branch of -Storage- (like Storage["log"]["{nodeId}"]["Controller"]).
ARCQuery.AggregationType.Sum	ARCQuery	EnumMember
ARCAPI.DataStorage.DocLinks	ARCAPI	ClassMember	Note that may be null.
ARCQuery.RelationalOperator	ARCQuery	Enum	Relational / comparision operators.
ARCAPI.DataStorage.Lock	ARCAPI	ClassMember	Locking object for thread-safe access from simultaneous API requests.
ARCQuery.RelationalOperator.EQ	ARCQuery	EnumMember
ARCAPI.DataStorage.ExternalReceiver	ARCAPI	ClassMember	Typically used by -AddController-.
ARCQuery.RelationalOperator.CONTAINS	ARCQuery	EnumMember
ARCAPI.DataStorage.DoNotStoreInternally	ARCAPI	ClassMember	Typically used by -AddController-.
ARCQuery.RelationalOperator.NEQ	ARCQuery	EnumMember
ARCAPI.BaseControllerP	ARCAPI	Enum	Describes class -BaseController-.
ARCQuery.RelationalOperator.NOTCONTAINS	ARCQuery	EnumMember
ARCAPI.BaseControllerP.CountRequest	ARCAPI	EnumMember	Number of calls to -APIMethod- since application initialization
ARCQuery.RelationalOperator.GT	ARCQuery	EnumMember
ARCAPI.BaseControllerP.CountException	ARCAPI	EnumMember	Number of exceptions at call to -APIMethod- since application initialization
ARCQuery.RelationalOperator.LT	ARCQuery	EnumMember
ARCAPI.BaseControllerP.LogLevel	ARCAPI	EnumMember
ARCQuery.RelationalOperator.GEQ	ARCQuery	EnumMember
ARCAPI.ResponseFormat	ARCAPI	Enum	The response format, HTML or JSON, for an API request.
ARCQuery.RelationalOperator.LEQ	ARCQuery	EnumMember
ARCAPI.ResponseFormat.JSON	ARCAPI	EnumMember
ARCQuery.RelationalOperator.LIKE	ARCQuery	EnumMember	Case sensitive string wildcard comparision.
ARCAPI.ResponseFormat.HTML	ARCAPI	EnumMember
ARCQuery.RelationalOperator.ILIKE	ARCQuery	EnumMember	Case insensitive string wildcard comparision.
Assembly AgoBrowse		Assembly
ARCQuery.RelationalOperator.NOTLIKE	ARCQuery	EnumMember	Case sensitive string wildcard comparision.
AgoBrowse.Program	AgoBrowse	Class
ARCQuery.RelationalOperator.NOTILIKE	ARCQuery	EnumMember	Case insensitive string wildcard comparision.
AgoBrowse.Program.InitStreamProcessor	AgoBrowse	ClassMember	Initializes stream processor.
ARCQuery.Strictness	ARCQuery	Enum	Describes level of -Strictness- when executing query.
AgoBrowse.Root	AgoBrowse	Class	Contains the user friendly welcome text (front page) for the application.
ARCQuery.Strictness.ON	ARCQuery	EnumMember
AgoBrowse.Root.ToHTMLSimpleSingle	AgoBrowse	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCQuery.EntityMethodKey+MethodType.Complex	ARCQuery	EnumMember	Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)'
ARCQuery.QueryExpressionWhere+WildcardPositionType	ARCQuery	Enum	Position of wildcard in value, like 'ABC' (-AtStart-), 'ABC' (-AtEnd-) and
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart	ARCQuery	EnumMember	Example: '*ABC'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd	ARCQuery	EnumMember	Example: 'ABC*'.
ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd	ARCQuery	EnumMember	Example: 'ABC'.
ARCQuery.QueryExpressionWhere+ValueEnum	ARCQuery	Enum	Helper enum used internally by -QueryExpressionWhere- in order to represent queries like WHERE Name = NULL, WHERE Name = NOTNULL and WHERE Name = * (ALL).
ARCQuery.QueryExpressionWhere+ValueEnum.NULL	ARCQuery	EnumMember
ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL	ARCQuery	EnumMember	Practical value enabling suggestions from -GetPrevious- and -GetNext-.
ARCQuery.QueryExpressionWhere+ValueEnum.ALL	ARCQuery	EnumMember	Equivalent to query like WHERE Name = *
ARCQuery.ValueComparerDateTime+ResolutionEnum	ARCQuery	Enum
ARCQuery.ValueComparerDateTime+ResolutionEnum.Second	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Day	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Week	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Month	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter	ARCQuery	EnumMember
ARCQuery.ValueComparerDateTime+ResolutionEnum.Year	ARCQuery	EnumMember
Assembly ARCAPI		Assembly	A library providing an API on top of the -PropertyStream-.
ARCAPI.ContentResult	ARCAPI	Class	Mimicks Microsoft.AspNetCore.Mvc.ContentResult.
ARCAPI.ContentResult.CreateHTMLOK	ARCAPI	ClassMember	NOTE: Parameter must be a complete HTML page.
ARCAPI.ContentResult.CreateError	ARCAPI	ClassMember	TODO: Add a key / value format for error messages, like done for -Log-.
ARCAPI.AddController	ARCAPI	Class	Parses and stores a -PropertyStreamLine-.
ARCAPI.AddController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.AddController.ToString	ARCAPI	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCAPI.AddController.AllowFilter	ARCAPI	ClassMember	Describes what data is allowed to change through a list of -Subscription- instances.
ARCAPI.BaseController	ARCAPI	Class	Contains basic functionality for serving API methods.
ARCAPI.BaseController.BuildControllerStorage	ARCAPI	ClassMember	Builds a collection of 'std' (standard) controller instances to use for serving API requests.
ARCAPI.BaseController.APIMethod	ARCAPI	ClassMember	The (only) API method that this controller supports.
ARCAPI.BaseController.CatchAll	ARCAPI	ClassMember	Serves the typical single generic API method in an AgoRapide API.
ARCAPI.BaseController.TryNavigateToLevelInDataStorage	ARCAPI	ClassMember	Navigates to the specified level (usually within -Storage-).
ARCAPI.BaseController.GetFormatAndAdjustRequest	ARCAPI	ClassMember	Decides -ResponseFormat- (like HTML, JSON, CSV, PDF and so on).
AgoBrowse.Root.TryGetP	AgoBrowse	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
AgoBrowse.Root.TryGetV	AgoBrowse	ClassMember	Note 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.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.CompileController	AgoBrowse	Class	Compiles a hierarchical 'picture book' from the requested position in the -DataStorage-.
AgoBrowse.Controllers.CompileController.APIMethod	AgoBrowse	ClassMember	The (only) API method that this controller supports.
AgoBrowse.Controllers.CompileController.Compile	AgoBrowse	ClassMember	Compiles a hierarchical 'picture book' from the given parameter.
AgoBrowse.Controllers.CompileController.ToString	AgoBrowse	ClassMember	TODO: Decide on what we actually want with ToString for this class.
AgoBrowse.Controllers.ControllerFacade	AgoBrowse	Class	Facade for entry into the desired -RQController-.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload2	AgoBrowse	ClassMember	Catches all HTTP GET requests to this API.
AgoBrowse.Controllers.ControllerFacade.CatchAll Overload1	AgoBrowse	ClassMember	Catches all HTTP POST requests to this API.
Namespace ARCCore		Namespace	A necessary library (.DLL in Windows terms) that every -ARNodeType- should link to.
Namespace ARCDoc		Namespace	A library supporting documentation and demonstrating usage of AgoRapide.
Namespace ARCQuery		Namespace	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
Namespace ARCAPI		Namespace	A library providing an API on top of the -PropertyStream-.
Namespace AgoBrowse		Namespace
Namespace AgoBrowse.Controllers		Namespace
ARCCore.ARComponents.ARCDoc	ARCCore	EnumMember	A library supporting documentation and demonstrating usage of AgoRapide.
ARCCore.ARComponents.ARCQuery	ARCCore	EnumMember	ARCQuery provides a query language that mimicks SQL but is usable through HTTP as GET URLs.
ARCCore.ARComponents.ARCEvent	ARCCore	EnumMember	ARCEvent contains an -EventSourcing- engine offering a unique -PropertyStream2D- concept where processes (of some business domain) can be expressed in very compact manner through the concept of -IRegHandler-.
ARCCore.ARComponents.ARCSync	ARCCore	EnumMember	(Not implemented as of March 2020)
ARCCore.ARComponents.ARCSec	ARCCore	EnumMember	(Not implemented as of March 2020)
ARCCore.ARComponents.ARCAPI	ARCCore	EnumMember	A library providing an API on top of the -PropertyStream-.
ARCCore.ARComponents.ARAAPI	ARCCore	EnumMember	The corresponding template application for -ARCAPI- demonstrating its usage, providing an HTTP / HTTPS interface with the help of Microsoft.AspNetCore.Mvc.
ARCCore.ARConcepts	ARCCore	Enum	The overarching concepts upon which AgoRapide is built.
ARCCore.ARNodeType.ArmDB	ARCCore	EnumMember	A node with a 'client -Subscription-' towards -CoreDB- to a (usually) subset of the entire database (acting as a cache and filtering mechanism), or with a 'client -Subscription-' towards -CoreDB- to the whole database (acting as a cache mechanism only)
ARCCore.ARNodeType.Client	ARCCore	EnumMember	An outer node / 'end' node with (usually) -ApplicationSpecificCode- but based on -ARADB-.
ARCCore.Cardinality	ARCCore	Enum	Describes how multiple instances of a property is supposed to be handled.
ARCCore.Cardinality.HistoryOnly	ARCCore	EnumMember	The default value.
ARCCore.Cardinality.WholeCollection	ARCCore	EnumMember	Values are always set as a whole (there is no need or no meaning in setting or deleting individual items)
ARCCore.Cardinality.IndividualItems	ARCCore	EnumMember	Values are supposed to be set and 'deleted' individually.
ARCCore.PSPrefix	ARCCore	Enum	Describes some recommended prefixes to use in a -PropertyStreamLine-.
ARCCore.PSPrefix.dt	ARCCore	EnumMember	Data, single key + value.
ARCCore.PSPrefix.dtr	ARCCore	EnumMember	Data, whole records.
ARCCore.PSPrefix.RS	ARCCore	EnumMember	RS = Registration Stream (see -RegStream-).
ARCCore.PSPrefix.ES	ARCCore	EnumMember	ES = Event Stream (see -EventStream-).
ARCCore.PSPrefix.cmd	ARCCore	EnumMember	Command.
ARCCore.PSPrefix.app	ARCCore	EnumMember	Application state, like app/
ARCCore.PSPrefix.doc	ARCCore	EnumMember	Documentation.
ARCCore.PSPrefix.t	ARCCore	EnumMember	Translations.
ARCCore.PKHTMLAttributeP	ARCCore	Enum	Describes class -PKRelAttribute-.
ARCCore.ConnectionInstructionP.Sharding	ARCCore	EnumMember
ARCCore.MultipleConnectionUsage	ARCCore	Enum	Enables fault-tolerance by describing use of multiple connections
ARCCore.MultipleConnectionUsage.Admin	ARCCore	EnumMember	Connection is a special administrative connection to a central 'command-and-control' server which instructs which connections to make.
ARCCore.MultipleConnectionUsage.RoundRobin	ARCCore	EnumMember	This connection to be used in a turn based system, together with other connections with -RoundRobin-.
ARCCore.MultipleConnectionUsage.Simultaneous	ARCCore	EnumMember	This connection to be used simultaneously with other connections with -Simultaneous-
ARCCore.StreamProcessorP	ARCCore	Enum	Describes class -StreamProcessor-.
ARCCore.StreamProcessorP.LocalStorageFolder	ARCCore	EnumMember	The local path to which new properties are stored. Should NOT end with any trailing DirectorySeparatorChar
ARCCore.StreamProcessorP.IndividualStorageFileSize	ARCCore	EnumMember	Max size (in bytes) for a single storage file before a new file is created by call to -StreamProcessor.CreateNewStorageFile-.
ARCCore.StreamProcessorP.CurrentlyInitializing	ARCCore	EnumMember	Set to TRUE at initialization (signals for instance -ReceiveAndDistribute- that it can only queue messages, not process them).
ARCCore.StreamProcessorP.ClientUpdatePositionPath	ARCCore	EnumMember	Complete path to file containing -ClientUpdatePosition-.
ARCCore.StreamProcessorP.ClientUpdatePosition	ARCCore	EnumMember	Note how this is stored both as -ClientUpdatePosition- (on the client side) and -ClientUpdatePosition- (on the server side).
ARCCore.StreamProcessorP.IncomingConnectionsPortNo	ARCCore	EnumMember	If not set, then class will not listen for incoming connections (meaning that our application is probably a -Client-).
ARCCore.StreamProcessorP.UnderClosure	ARCCore	EnumMember	Set to TRUE if to be closed, whenever an exception occurs or when class goes out of scope
ARCCore.StreamProcessorP.WriteToConsole	ARCCore	EnumMember	If true then incoming data (from other nodes will be written to console.
ARCCore.StreamProcessorP.Timestamp	ARCCore	EnumMember	The timestamp inserted at regular intervals in the -PropertyStream- according to -TimestampResolution-.
ARCCore.StreamProcessorP.TimestampIsOld	ARCCore	EnumMember	A warning sent by -StreamProcessor- to -OutsideLocalReceiver- when it knows that data as served is out of date.
ARCDoc.Orange.Storage	ARCDoc	ClassMember	Uses int-value of -__enum- minus 1 as index.
ARCDoc.SomeAppComponent	ARCDoc	Class	Demonstrates how also your actual application classes, not only your data classes, should implement -IP-.
ARCDoc.SomeAppComponent.MethodC	ARCDoc	ClassMember	Note structured format in logging.
ARCDoc.SomeAppComponent.MethodD	ARCDoc	ClassMember	Same as MethodC- but returns data ('Func<string>()' instead of 'Action()')
ARCDoc.SomeAppComponent.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFrag	ARCDoc	Class	DocFrag = Document fragment.
ARCDoc.DocFrag.Create Overload1	ARCDoc	ClassMember	Creates a -DocFrag- object representing an assembly or a namespace.
ARCDoc.DocFrag.Create Overload2	ARCDoc	ClassMember	Creates a -DocFrag- object representing a class, class member, enum or enum member.
ARCDoc.DocFrag.ToHTMLSimpleSingle	ARCDoc	ClassMember	Alternative ('override') to -ToHTMLSimpleSingle-.
ARCDoc.DocFrag.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFrag.TryGetV	ARCDoc	ClassMember	Note 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).
ARCDoc.DocFrag.ToString	ARCDoc	ClassMember	TODO: Decide on what we actually want with ToString for this class.
ARCDoc.DocFragCollection	ARCDoc	Class	Contains a collection of -DocFrag- objects.
ARCDoc.DocFragCollection.Create	ARCDoc	ClassMember	Creates documentation fragments (-DocFrag-) for all possible -BaseAttribute- elements found in the given assemblies.
ARCDoc.DocFragCollection.TryGetP	ARCDoc	ClassMember	Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCDoc.DocFragCollection.TryGetV	ARCDoc	ClassMember	Note 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).

Generated 2026-06-28 14:05:08.341 UTC