Note Element Class
This is used to handle note and alert elements in a topic
Definition
Namespace: Sandcastle.Core.PresentationStyle.Transformation.Elements
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2026.1.20.0
C#
public class NoteElement : ElementVB
Public Class NoteElement
Inherits ElementC++
public ref class NoteElement : public ElementF#
type NoteElement =
class
inherit Element
endConstructors
| NoteElement | Constructor |
Properties
| CautionAlertTemplatePath | This is used to get or set the Caution alert template file path |
| DoNotParse |
This is used to get or set whether or not to parse the element for Markdown content
(Inherited from Element) |
| IsBlockElement |
This read-only property returns true if the element is a block element, false if it is not.
(Inherited from Element) |
| LanguageAlertTemplatePath | This is used to get or set the Language alert template file path |
| Name |
This read-only property returns the element name
(Inherited from Element) |
| NoteAlertTemplatePath | This is used to get or set the Note alert template file path |
| SecurityAlertTemplatePath | This is used to get or set the Security alert template file path |
| ToDoAlertTemplatePath | This is used to get or set the To Do alert template file path |
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) |