MSHelpAttr Class

MSHelpAttr Class

This represents an MS Help 2 attribute that can be added to the XML data island in each help topic generated by BuildAssembler.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.UtilsPropertyBasedCollectionItem
SandcastleBuilder.UtilsMSHelpAttr

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

[SerializableAttribute]
public class MSHelpAttr : PropertyBasedCollectionItem, IComparable<MSHelpAttr>, 
	INotifyPropertyChanged

<SerializableAttribute>
Public Class MSHelpAttr
	Inherits PropertyBasedCollectionItem
	Implements IComparable(Of MSHelpAttr), INotifyPropertyChanged

[SerializableAttribute]
public ref class MSHelpAttr : public PropertyBasedCollectionItem, 
	IComparable<MSHelpAttr^>, INotifyPropertyChanged

[<SerializableAttribute>]
type MSHelpAttr =  
    class
        inherit PropertyBasedCollectionItem
        interface IComparable<MSHelpAttr>
        interface INotifyPropertyChanged
    end

The MSHelpAttr type exposes the following members.

Constructors

	Name	Description
	MSHelpAttr	Default constructor

Top

Methods

	Name	Description
	CheckProjectIsEditable	This is used to see if the project can be edited. If not, abort the change by throwing an exception. (Inherited from PropertyBasedCollectionItem.)
	CompareTo	Compares this instance to another instance and returns an indication of their relative values.
	Equals	Determines whether the specified Object is equal to the current Object. (Overrides ObjectEquals(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	Get a hash code for this item (Overrides ObjectGetHashCode.)
	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	Return a string representation of the item (Overrides ObjectToString.)

Top

Properties

	Name	Description
	AttributeName	This is used to get or set the attribute name
	AttributeValue	This is used to get or set the attribute value
	IsDirty	This is used to get or set the dirty state of the item (Inherited from PropertyBasedCollectionItem.)
	ProjectFile	This is used to get the owning project file (Inherited from PropertyBasedCollectionItem.)

Top

Events

	Name	Description
	PropertyChanged	The property changed event

Top

Reference

SandcastleBuilder.Utils Namespace