ApiTopicSectionType Enumeration

This enumerated type defines the sections that are rendered in an API topic

Definition

Namespace: Sandcastle.Core.PresentationStyle.Transformation
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#View SourceRequest Example
[SerializableAttribute]
public enum ApiTopicSectionType

Remarks

Section order may vary from one presentation style to another and may be customized by plug-ins

Members

Notices0 The notices such as the preliminary API and obsolete warnings
Summary1 The summary section.
InheritanceHierarchyAbbreviated2 The abbreviated inheritance hierarchy.
NamespaceAndAssemblyInfo3 Namespace and assembly information.
SyntaxSection4 The syntax section.
MemberList5 A member list based on the topic type (root, root group, namespace group, namespace, enumeration, type, or type members).
Events6 The events section.
Exceptions7 The exceptions section.
Remarks8 The remarks section.
Examples9 The examples section.
Platforms10 The platforms section (reserved for future use).
Versions11 The versions section.
Permissions12 The permissions section.
ThreadSafety13 The thread safety section.
RevisionHistory14 The revision history section.
Bibliography15 The bibliography section.
SeeAlso16 The See Also section.
InheritanceHierarchyFull17 The full inheritance hierarchy.
CustomSection18 A custom section.

See Also