MSHelpKeyword Class

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

Definition

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
public class MSHelpKeyword : IComparable<MSHelpKeyword>, 
	INotifyPropertyChanged
Inheritance
Object    MSHelpKeyword
Implements
INotifyPropertyChanged, IComparableMSHelpKeyword

Constructors

Properties

Index This is used to get or set the index name
IndexNamesDataSource This read-only property returns a dictionary containing the valid index names and their descriptions suitable for data binding.
Term This is used to get or set the index term
ValidIndexNames This read-only property returns an enumerable list of valid index names

Methods

CompareTo Compares this instance to another instance and returns an indication of their relative values
EqualsDetermines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object))
FinalizeAllows 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)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates 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)

Events

PropertyChanged The property changed event

See Also