Standard Document Model Class
This is used to add the standard document model elements to the reflection information file
Definition
Namespace: Sandcastle.Core.PresentationStyle
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#
public class StandardDocumentModel : IApplyDocumentModelVB
Public Class StandardDocumentModel
Implements IApplyDocumentModelC++
public ref class StandardDocumentModel : IApplyDocumentModelF#
type StandardDocumentModel =
class
interface IApplyDocumentModel
end- Inheritance
- Object StandardDocumentModel
- Implements
- IApplyDocumentModel
Remarks
The generator has the following behaviors:
- If a root namespace container ID is specified, a root namespace container API entry (R:) is added with a list of the namespaces. If not specified, it is omitted.
- A topicdata element is added to each API entry to identify the topic group. For enumeration members (the fields), a notopic attribute is added to indicate that it should not get a separate topic. For explicitly implemented members, an eiiname attribute is added to identify the explicitly implemented type and member name.
- library elements are updated with the assembly version and, for type members, a NoAptca element is added if the assembly does not allow partially trusted callers.
- Elements for overloaded methods are grouped into Overload elements within their type's API entry. Extension methods are not grouped if overloaded but do get an overload attribute.
- The API entries for overloaded members have an overload attribute added to their memberdata element to identify the overload topic ID.
- For all types except enumerations, member list topic API entries are created for methods, operators, properties, events, fields, attached properties, attached events, and overloaded members.
Constructors
| StandardDocumentModel | Initializes a new instance of the StandardDocumentModel class |
Properties
| RootNamespaceContainerId | This is used to get or set an optional root namespace container ID |
Methods
| ApplyDocumentModel | This is used to apply the document model to a reflection information file |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |