WildcardReferenceSettings Class

This represents wildcard reference settings for the WildcardReferencesPlugIn.

Definition

Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2024.2.18.0
public class WildcardReferenceSettings : INotifyPropertyChanged
Inheritance
Object    WildcardReferenceSettings
Implements
INotifyPropertyChanged

Constructors

Properties

ErrorMessage This read-only property returns an error message describing any issues with the settings
Recursive This is used to get or set whether or not to scan sub-folders recursively
ReferenceDescription This returns a description of the entry suitable for display in a bound list control
ReferencePath This is used to get or set the path to scan for references.
Wildcard This is used to get or set the wildcard to use with the folder

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows 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 wildcard reference settings instance from an XElement containing the settings
GetHashCodeServes as the default hash function.
(Inherited from Object)
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
ToStringReturns a string that represents the current object.
(Inherited from Object)
ToXml Store the wildcard reference settings as a node in the given XML element

Events

PropertyChanged The property changed event

See Also