[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 976 > < TAKE 125 >
125 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCDoc.DummyEnum | ARCDoc | Class | TODO: Document better what this is for (and change name) |
| ARCDoc.DummyEnum.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.DummyEnum.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.DummyEnum.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.Extensions | ARCDoc | Class | Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML. |
| ARCDoc.Extensions.ToHTMLSimpleSingleRecursive | ARCDoc | ClassMember | Calls -ToHTMLSimpleSingle- recursively. |
| ARCDoc.Extensions.ToHTMLSimpleSingle | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter. |
| ARCDoc.Extensions.ToHTMLSimpleSingleInternal | ARCDoc | ClassMember | Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-. |
| ARCDoc.Extensions.ToHTMLSimpleAsTableRow | ARCDoc | ClassMember | Creates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table. |
| ARCDoc.Extensions.DescribeValue | ARCDoc | ClassMember | Describes the value contained withing an -IKIP- (-P-). |
| ARCDoc.Extensions.ValueToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Value with description as a 'tooltip'. |
| ARCDoc.Extensions.KeyToHTMLSimpleWithTooltip | ARCDoc | ClassMember | Creates a simple HTML representation of the Key with description as a 'tooltip'. |
| ARCDoc.Extensions.GetHelptextHTML | ARCDoc | ClassMember | Returns content of -Description- and -LongDescription-. |
| ARCDoc.HLocation | ARCDoc | Class | Simple class describing the location of a single -IP- instance within some hierarhical context. |
| ARCDoc.HLocation.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.HLocation.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.HLocation.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HLocation.Content | ARCDoc | ClassMember | The Content object is not stored within the standard -IP--mechanism. |
| ARCDoc.HLocationCollection | ARCDoc | Class | Contains a collection of -HLocation- objects. |
| ARCDoc.HLocationCollection.Create | ARCDoc | ClassMember | Transforms the parameter (and recursively all contained objects) into a collection of -HLocation- objects. |
| ARCDoc.HLocationCollection.WriteAllContentHTMLToDisk | ARCDoc | ClassMember | Writes all -HLocation- results to a hierarhical folder structure as static HTML files with (optionally) -LinkInsertionInDocumentation-. |
| ARCDoc.HLocationCollection.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.HLocationCollection.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.HLocationCollection.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HTOC | ARCDoc | Class | HTOC = Hierarchical table of contents. |
| ARCDoc.HTOC.Create | ARCDoc | ClassMember | Structures content hierarchically according to the criteria for each level. |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload2 | ARCDoc | ClassMember | Alternative ('override') to -ToHTMLSimpleSingle-. |
| ARCDoc.HTOC.ToHTMLSimpleSingle Overload1 | ARCDoc | ClassMember | Use this method in any class where a table-of-contents type of view is desireable |
| ARCDoc.HTOC.CreateInitialContent | ARCDoc | ClassMember | Helper method for creation of a -FilterBranch-. |
| ARCDoc.HTOC.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.HTOC.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.HTOC.ToString | ARCDoc | ClassMember | TODO: Decide on what we actually want with ToString for this class. |
| ARCDoc.HTOC.HTOCContentThisLevelKey | ARCDoc | ClassMember | The key used for storing the actual content at this level. |
| ARCDoc.PKDocAttribute | ARCDoc | Class | Describes documentation and presentation of a property. |
| ARCDoc.PKDocAttribute.Initialize | ARCDoc | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCDoc.PKDocAttribute.TryRemoveP | ARCDoc | ClassMember | Should probably never be used. |
| ARCDoc.PKDocAttribute.PriorityOrder | ARCDoc | ClassMember | See -PriorityOrder-. |
| ARCDoc.PKDocAttribute.IsDefault | ARCDoc | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCDoc.UtilDoc | ARCDoc | Class | Utility methods for -ARCDoc-. |
| ARCDoc.UtilDoc.GetCurrentLevelInHierarchyAsHTML | ARCDoc | ClassMember | Returns an HTML presentation of the given link context, with links pointing backwards to each level in the hierarchy. |
| ARCDoc.UtilDoc.GenerateHTMLPage | ARCDoc | ClassMember | Wraps the parameter inside a <html><head></head><body>...</body></html> enclosure with some rudimentare CSS. |
| ARCDoc.UtilDoc.GlobalHeaderHTML | ARCDoc | ClassMember | Global header to be inserted at the top of every HTML page created by -GenerateHTMLPage-. |
| ARCDoc.HTOC+ParentChain | ARCDoc | Class | Used by -FilterNode- in order to keep track of node's parents. |
| ARCDoc.AppleP | ARCDoc | Enum | Describes class -Apple-. |
| ARCDoc.AppleP.Name | ARCDoc | EnumMember | The name of the apple |
| ARCDoc.AppleP.Colour | ARCDoc | EnumMember | |
| ARCDoc.BananaP | ARCDoc | Enum | Describes class -Banana-. |
| ARCDoc.BananaP.Name | ARCDoc | EnumMember | The name of the banana |
| ARCDoc.BananaP.Colour | ARCDoc | EnumMember | |
| ARCDoc.OrangeP | ARCDoc | Enum | Describes class -Orange-. |
| ARCQuery.QueryProgressP.Title | ARCQuery | EnumMember | The title to be used in the final presentation of the query result. |
| ARCDoc.OrangeP.Name | ARCDoc | EnumMember | The name of the orange |
| ARCQuery.QueryProgressP.Queries | ARCQuery | EnumMember | |
| ARCDoc.OrangeP.Colour | ARCDoc | EnumMember | |
| ARCQuery.QueryProgressP.StrCurrentType | ARCQuery | EnumMember | Normally the -ToStringVeryShort- representation of the type of objects in the -Result- collection. |
| ARCDoc.SomeAppComponentP | ARCDoc | Enum | Describes class -SomeAppComponent-. |
| ARCQuery.QueryProgressP.CurrentStrictness | ARCQuery | EnumMember | Describes -Strictness- ON / OFF when executing query. |
| ARCDoc.SomeAppComponentP.SomeCountValue | ARCDoc | EnumMember | |
| ARCQuery.QueryProgressP.CreateHints | ARCQuery | EnumMember | Describes if hints are to be generated (as query progresses) for new queries. |
| ARCDoc.SomeAppComponentP.SomeCountValueNotToBeLogged | ARCDoc | EnumMember | |
| ARCQuery.QueryProgressP.UseCache | ARCQuery | EnumMember | Describes if cache is to be used or not. |
| ARCDoc.DocFragP | ARCDoc | Enum | Describes class -DocFrag-. |
| ARCQuery.QueryProgressP.LinkAdjustment | ARCQuery | EnumMember | Experimental: Adjustment to be done by -QueryProgress-.- ToHTMLSimpleSingle- (when it ascertains how to go back to root level). |
| ARCDoc.DocFragP.DocFragType | ARCDoc | EnumMember | |
| ARCQuery.QueryProgressP.Limit | ARCQuery | EnumMember | Limits 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. |
| ARCDoc.DocFragP.Assembly | ARCDoc | EnumMember | Name of the assembly in which this fragment resides. |
| ARCQuery.QueryProgressP.TerminateReason | ARCQuery | EnumMember | The reason for a query being terminated. This property should contain a user friendly message about the problem and how to fix it. |
| ARCDoc.DocFragP.Namespace | ARCDoc | EnumMember | Namespace in which this fragment resides. |
| ARCQuery.QueryProgressP.AllLogEntriesForThisQuery | ARCQuery | EnumMember | |
| ARCDoc.DocFragP.ParentNamespace | ARCDoc | EnumMember | Parent namespace of namespace in which this fragment resides. |
| ARCQuery.TranslationsP | ARCQuery | Enum | This enum has no values because the keys are the actual string to be translated. |
| ARCDoc.DocFragP.Type | ARCDoc | EnumMember | Type of class or enum which this fragment describes (also relevant for class or enum member). |
| ARCQuery.TranslationSingleP | ARCQuery | Enum | Describes class -TranslationSingle-. |
| ARCDoc.DocFragP.Name | ARCDoc | EnumMember | As simple a name as practical usable. Often not unique within a greater context. |
| ARCQuery.TranslationSingleP.Text | ARCQuery | EnumMember | |
| ARCDoc.DocFragP.IsInherited | ARCDoc | EnumMember | Relevant for class members. TRUE if method is inherited from a base type. |
| ARCQuery.TranslationSingleP.IsMissing | ARCQuery | EnumMember | Value TRUE indicates that the Text given is simply the original key, in other words, the translation for the key is actually missing. |
| ARCDoc.DocFragP.IsInheritedDoc | ARCDoc | EnumMember | Relevant for class members (methods). |
| ARCQuery.EntityMethodKey+MethodType | ARCQuery | Enum | Explains type of method signature found (trough reflection) for corresponding entity class. |
| ARCDoc.DocFragP.Lines | ARCDoc | EnumMember | Number of lines of text in -Description- and -LongDescription- for this fragment. |
| ARCQuery.EntityMethodKey+MethodType.Simple | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(out IP retval, out string errorResponse)' |
| ARCDoc.DocFragP.Attribute | ARCDoc | EnumMember | The -BaseAttribute- or -PK- from which this -DocFrag- originates. |
| ARCQuery.EntityMethodKey+MethodType.Complex | ARCQuery | EnumMember | Signature like 'bool TryGet{KeyName}(IP dataStorage, IK thisKey, out IP retval, out string errorResponse)' |
| ARCDoc.DocFragType | ARCDoc | Enum | Type of documentation fragment, like -Assembly-, -Class- or -ClassMember-. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType | ARCQuery | Enum | Position of wildcard in value, like '*ABC' (-AtStart-), 'ABC*' (-AtEnd-) and |
| ARCDoc.DocFragType.Assembly | ARCDoc | EnumMember | |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStart | ARCQuery | EnumMember | Example: '*ABC'. |
| ARCDoc.DocFragType.Namespace | ARCDoc | EnumMember | |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtEnd | ARCQuery | EnumMember | Example: 'ABC*'. |
| ARCDoc.DocFragType.Class | ARCDoc | EnumMember | Does also include interfaces. |
| ARCQuery.QueryExpressionWhere+WildcardPositionType.AtStartAndEnd | ARCQuery | EnumMember | Example: '*ABC*'. |
| ARCDoc.DocFragType.ClassMember | ARCDoc | EnumMember | |
| 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). |
| ARCDoc.DocFragType.Enum | ARCDoc | EnumMember | |
| ARCQuery.QueryExpressionWhere+ValueEnum.NULL | ARCQuery | EnumMember | |
| ARCDoc.DocFragType.EnumMember | ARCDoc | EnumMember | |
| ARCQuery.QueryExpressionWhere+ValueEnum.NOTNULL | ARCQuery | EnumMember | Practical value enabling suggestions from -GetPrevious- and -GetNext-. |
| ARCDoc.DocLinkP | ARCDoc | Enum | Describes class -DocLink-. |
| ARCQuery.QueryExpressionWhere+ValueEnum.ALL | ARCQuery | EnumMember | Equivalent to query like WHERE Name = * |
| ARCDoc.DocLinkP.Location | ARCDoc | EnumMember | The location that this link points to. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum | ARCQuery | Enum | |
| ARCDoc.DocLinkP.Filename | ARCDoc | EnumMember | |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Second | ARCQuery | EnumMember | |
| ARCDoc.DocLinkP.LinkWordHTML | ARCDoc | EnumMember | Actual link as it is expected to occur in text, like '-MyCustomerClass<T>-'. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Minute | ARCQuery | EnumMember | |
| ARCDoc.DocLinkResolutionP | ARCDoc | Enum | Describes class -DocLinkResolution- |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Hour | ARCQuery | EnumMember | |
| ARCDoc.DocLinkResolutionP.LinkWord | ARCDoc | EnumMember | |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Day | ARCQuery | EnumMember | |
| ARCDoc.DocLinkResolutionP.DocLinks | ARCDoc | EnumMember | The possible links for -LinkWord- |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Week | ARCQuery | EnumMember | |
| ARCDoc.DocumentatorP | ARCDoc | Enum | Describes class -Documentator-. |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Month | ARCQuery | EnumMember | |
| ARCDoc.DummyEnumP | ARCDoc | Enum | TODO: Document better what this is for (and change name) |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Quarter | ARCQuery | EnumMember | |
| ARCDoc.DummyEnumP._MemberInherited | ARCDoc | EnumMember | Contains not only members which are inherited in the object-oriented sense, but also overrides for which the only documentation was found in base class |
| ARCQuery.ValueComparerDateTime+ResolutionEnum.Year | ARCQuery | EnumMember | |
| ARCDoc.HLocationP | ARCDoc | Enum | Describes class -HLocation-. |
| Assembly ARCAPI | Assembly | A library providing an API on top of the -PropertyStream-. | |
| ARCDoc.HLocationP.Location | ARCDoc | EnumMember | Folder names / hierarchical levels. |
| ARCAPI.ContentResult | ARCAPI | Class | Mimicks Microsoft.AspNetCore.Mvc.ContentResult. |
| ARCDoc.HLocationP.Filename | ARCDoc | EnumMember | Either the last hierarhical key for the content's location, or Index.html if no location. |
| ARCAPI.ContentResult.CreateHTMLOK | ARCAPI | ClassMember | NOTE: Parameter must be a complete HTML page. |
| ARCDoc.HLocationP.ContentType | ARCDoc | EnumMember | The type of the content object. The actual content object is stored as -Content-. |
| ARCAPI.ContentResult.CreateError | ARCAPI | ClassMember | TODO: Add a key / value format for error messages, like done for -Log-. |
Generated 2025-07-11 13:15:16.296 UTC