Sandcastle Help File Builder Documentation
Api
This handles rendering of an API topic section
Definition
Namespace: Sandcastle.Core.PresentationStyle.Transformation.Elements
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
C#
public class ApiTopicSectionHandlerVB
Public Class ApiTopicSectionHandlerC++
public ref class ApiTopicSectionHandlerF#
type ApiTopicSectionHandler = class end- Inheritance
- Object ApiTopicSectionHandler
Remarks
API topics are rendered in various sections based on the topic type. This facilitates rendering
those sections.
Constructors
| ApiTopicSectionHandler(ApiTopicSectionType, ActionTopicTransformationCore) | Constructor for well-known sections |
| ApiTopicSectionHandler(ApiTopicSectionType, String, ActionTopicTransformationCore) | This constructor supporting specifying a custom section type and name |
Properties
| CustomSectionName | If SectionType is CustomSection, this contains the custom section name |
| RenderSection | This is the action to perform that will render the section |
| SectionType | The section type |
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) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |