Table of Contents

TopicTransformationExtensions Class

Definition

Namespace
Sandcastle.Core.PresentationStyle.Transformation
Assembly
Sandcastle.Core.dll

This contains various extension and utility methods for presentation style transformations

public static class TopicTransformationExtensions
Inheritance
TopicTransformationExtensions

Methods

AttributeOfType(XElement, string)

This is used to retrieve the first attribute of the given type from an API element's attributes node.

FollowingSiblings(XElement, XName)

Return all following sibling elements that optionally match the given element's name

FormatSignedEnumValue(string, EnumValueFormat, int, int)

Format a signed enumeration value using the given options

FormatUnsignedEnumValue(string, EnumValueFormat, int, int)

Format an unsigned enumeration value using the given options

GenerateUniqueId(XNode)

This is used to generate a unique ID for an XML node

InsertWordBreakOpportunities(string)

Insert word break opportunities into HTML text to allow better word wrapping when the text container is narrow like the Table of Contents pane.

NormalizeWhiteSpace(string)

Normalize whitespace in a string by replacing consecutive runs of whitespace with a single space and removing leading and trailing whitespace.

PrecedingSiblings(XElement, XName)

Return all preceding sibling elements that optionally match the given element's name

RemoveNamespaces(XElement)

Remove namespaces from an element and all of its descendants including attributes

ToBoolean(XAttribute)

This converts an attribute value to a Boolean value. If not present, blank, or invalid, it returns false.

ToIndent(int)

This is used to convert the given size to an indent consisting of two non-breaking spaces for each indent level.