Notice Class

This represents a notice that appears at the top of a topic or as a tag for the member in the list page

Definition

Namespace: Sandcastle.Core.PresentationStyle.Transformation
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.3.22.0

C#View SourceRequest Example
public class Notice : INotifyPropertyChanged

VBView SourceRequest Example
Public Class Notice
	Implements INotifyPropertyChanged

C++View SourceRequest Example
public ref class Notice : INotifyPropertyChanged

F#View SourceRequest Example
type Notice = 
    class
        interface INotifyPropertyChanged
    end

Initializes a new instance of the Notice class

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.

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)
FromXml	Create a notice instance from an XElement containing the settings
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)
OnPropertyChanged	This raises the PropertyChanged event
ToString	Returns a string that represents the current object. (Inherited from Object)
ToXml	Store the wildcard reference settings as a node in the given XML element

The property changed event