Table of Contents

MSHelpKeyword Class

Definition

Namespace
Sandcastle.Core.ConceptualContent
Assembly
Sandcastle.Core.dll

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

public class MSHelpKeyword : IComparable<MSHelpKeyword>, INotifyPropertyChanged
Inheritance
MSHelpKeyword
Implements

Constructors

MSHelpKeyword()

Constructor

MSHelpKeyword(string, string)

Constructor

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(MSHelpKeyword)

Compares this instance to another instance and returns an indication of their relative values

Equals(object)
GetHashCode()

Get a hash code for this item

OnPropertyChanged(string)

This raises the PropertyChanged event

ToString()

Return a string representation of the item

Events

PropertyChanged

The property changed event