MSHelpKeyword Class

MSHelpKeyword Class

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

Inheritance Hierarchy

SystemObject
SandcastleBuilder.UtilsMSHelpKeyword

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

Syntax

C++

Copy

[SerializableAttribute]
public class MSHelpKeyword : IComparable<MSHelpKeyword>, 
	INotifyPropertyChanged

<SerializableAttribute>
Public Class MSHelpKeyword
	Implements IComparable(Of MSHelpKeyword), INotifyPropertyChanged

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

[<SerializableAttribute>]
type MSHelpKeyword =  
    class
        interface IComparable<MSHelpKeyword>
        interface INotifyPropertyChanged
    end

The MSHelpKeyword type exposes the following members.

Constructors

	Name	Description
	MSHelpKeyword	Constructor
	MSHelpKeyword(String, String)	Constructor

Top

Methods

	Name	Description
	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
	Index	This is used to get or set the index name
	Term	This is used to get or set the index term
	ValidIndexNames	This read-only property returns an enumerable list of valid index names

Top

Events

	Name	Description
	PropertyChanged	The property changed event

Top

Reference

SandcastleBuilder.Utils Namespace