Sandcastle Help File Builder Documentation
Topic
Create a topic section with a title
Definition
Namespace: Sandcastle.Core.PresentationStyle.Transformation
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0
A tuple containing a reference to the title element if a title was created, null if not, and a reference to the content element into which any additional content can be rendered or null if it should be rendered into the current topic element. Both elements should be added to the topic if created.
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.12.21.0
C#
public abstract (XElement Title, XElement Content) CreateSection(
string uniqueId,
bool localizedTitle,
string title,
string linkId
)VB
Public MustOverride Function CreateSection (
uniqueId As String,
localizedTitle As Boolean,
title As String,
linkId As String
) As (Title As XElement, Content As XElement)C++
public:
virtual ValueTuple<XElement^, XElement^> CreateSection(
String^ uniqueId,
bool localizedTitle,
String^ title,
String^ linkId
) abstractF#
abstract CreateSection :
uniqueId : string *
localizedTitle : bool *
title : string *
linkId : string -> ValueTuple<XElement, XElement> Parameters
- uniqueId String
- A unique ID that can be used to identify the section
- localizedTitle Boolean
- True if title is a localized include item, false if it is literal title text.
- title String
- The item id if localizedTitle is true, or the literal title text if it is false.
- linkId String
- An optional link ID for the section. If there is no title, this will be ignored.
Return Value
ValueTupleXElement, XElementA tuple containing a reference to the title element if a title was created, null if not, and a reference to the content element into which any additional content can be rendered or null if it should be rendered into the current topic element. Both elements should be added to the topic if created.