Notice Class
Definition
- Assembly
- Sandcastle.Core.dll
This represents a notice that appears at the top of a topic or as a tag for the member in the list page
public class Notice : INotifyPropertyChanged- Inheritance
-
Notice
- Implements
Properties
| AttributeTypeName |
An attribute type name if this notice is related to one |
| ElementName |
An XML comments element name if this notice is related to one |
| ErrorMessage |
This read-only property returns an error message describing any issues with the settings |
| ExperimentalNotice |
This returns a default instance of the experimental notice |
| NoticeDescription |
This returns a description of the entry suitable for display in a bound list control |
| NoticeMessage |
The notice message for the topic page |
| NoticeStyleClasses |
For HTML presentation styles, this allows you to set the CSS classes used for the topic notice. If not set, a default style will be used. |
| ObsoleteNotice |
This returns a default instance of the obsolete notice |
| PreliminaryNotice |
This returns a default instance of the preliminary notice |
| TagStyleClasses |
For HTML presentation styles, this allows you to set the CSS classes used for the member list tag. If not set, a default style will be used. |
| TagText |
The text for the tag on the member list page |
| UseValueForText |
Set this to true to have the notice show the XML comment text or the attribute value if present. If set to false or there is no inner text or value, the NoticeMessage will be used instead. |
Methods
| FromXml(XElement) |
Create a notice instance from an XElement containing the settings |
| OnPropertyChanged(string) |
This raises the PropertyChanged event |
| ToXml() |
Store the wildcard reference settings as a node in the given XML element |
Events
| PropertyChanged |
The property changed event |