AutoOutlineElement Class

This is used to handle autoOutline elements in a topic

Definition

Namespace: Sandcastle.Core.PresentationStyle.Transformation.Elements.Html
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0

C#View Source Request Example

public class AutoOutlineElement : Element

VBView Source Request Example

Public Class AutoOutlineElement
	Inherits Element

C++View Source Request Example

public ref class AutoOutlineElement : public Element

F#View Source Request Example

type AutoOutlineElement = 
    class
        inherit Element
    end

Inheritance: Object Element AutoOutlineElement

Remarks

This element inserts a bullet list of links to the topic's sections or a section's sub-sections with optional support for limiting the expansion down to a specific level. Authors can use the tag directly or specify a token (defined in a token file) in a topic's introduction to get a bullet list of the sections; or in a ddue:section/ddue:content to get a bullet list of the section's sub-sections. If the token is used, the shared content component replaces <token>autoOutline</token> with an <autoOutline/> node that you specify in the token's content. This was the old way of doing it but this version allows it to be specified directly like any other MAML tag.

The excludeRelatedTopics attribute can be set to true to exclude the link to the related topics section if present or set to false to omit it. If not specified, the default is true to include it.

The lead attribute can be included to specify the lead in text. It can be set to "none" to omit the lead in text. If omitted, default lead in text will be used.

Examples:

Example

XML

<!-- Show only top-level topic titles, default lead-in text, includes related
topics link -->
<autoOutline/>

<!-- Show only top-level topic titles without the related topics link, default
lead-in text -->
<autoOutline excludeRelatedTopics="true"/>

<!-- Add custom lead-in text -->
<autoOutline excludeRelatedTopics="true" lead="Changes in this release" />

<!-- Show top-level titles and titles for one level down, default lead-in text,
includes related topics link -->
<autoOutline>1</autoOutline>

<-- Show top-level titles and titles for one level down, omit the lead-in text
<autoOutline lead="none">1</autoOutline> -->

<-- Show titles from the top down to three levels, default lead-in text, includes
related topics link -->
<autoOutline>3</autoOutline>

Constructors

AutoOutlineElement

Initializes a new instance of the Object class.

Properties

Name	This read-only property returns the element name (Inherited from Element)
TopLevelStyleName	This is used to set a style class name on top-level auto-outlines

Methods

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)
Render	Render the element to the topic (Overrides ElementRender(TopicTransformationCore, XElement))
ToString	Returns a string that represents the current object. (Inherited from Object)