ApiTopicSectionType Enum

Definition

Namespace

Sandcastle.Core.PresentationStyle.Transformation

Assembly

Sandcastle.Core.dll

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

[Serializable]
public enum ApiTopicSectionType

Fields

Name	Value	Description
Notices	0	The notices such as the preliminary API and obsolete warnings This is typically rendered at the very top of the topic.
Summary	1	The summary section. For overload topics, the summary will come from the first overloads element.
InheritanceHierarchyAbbreviated	2	The abbreviated inheritance hierarchy. This is typically used in conjunction with InheritanceHierarchyFull with the abbreviated hierarchy appearing at the top of the topic and the full hierarchy appearing at the end of the topic if needed if the descendant count exceeds the abbreviated threshold (four descendants). In such cases, the abbreviated hierarchy will have a "More..." link to it.
NamespaceAndAssemblyInfo	3	Namespace and assembly information. Only API member pages get namespace and assembly info.
SyntaxSection	4	The syntax section. Only API member pages get a syntax section. This includes the declaration syntax, parameters, templates, return value, and implemented member information.
MemberList	5	A member list based on the topic type (root, root group, namespace group, namespace, enumeration, type, or type members).
Events	6	The events section.
Exceptions	7	The exceptions section.
Remarks	8	The remarks section. For overload topics, the remarks will come from the first overloads element.
Examples	9	The examples section. For overload topics, the examples will come from the first overloads element.
Platforms	10	The platforms section (reserved for future use).
Versions	11	The versions section. Only API member pages get version information.
Permissions	12	The permissions section.
ThreadSafety	13	The thread safety section.
RevisionHistory	14	The revision history section.
Bibliography	15	The bibliography section.
SeeAlso	16	The See Also section.
InheritanceHierarchyFull	17	The full inheritance hierarchy.
CustomSection	18	A custom section. This can be used by plug-ins to add new sections to an API topic.

Remarks

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