StringDifferenceOptions Structure

Options to use in calculating string differences.

Namespace:  Microsoft.VisualStudio.Text.Differencing
Assembly:  Microsoft.VisualStudio.Text.Data (in Microsoft.VisualStudio.Text.Data.dll)

Syntax

'Declaration
Public Structure StringDifferenceOptions

public struct StringDifferenceOptions

public value class StringDifferenceOptions

[<Sealed>]
type StringDifferenceOptions =  struct end

JScript supports the use of structures, but not the declaration of new ones.

The StringDifferenceOptions type exposes the following members.

Constructors

	Name	Description
	StringDifferenceOptions(StringDifferenceOptions)	Initializes a new instance of StringDifferenceOptions with the specified options.
	StringDifferenceOptions(StringDifferenceTypes, Int32, Boolean)	Initializes a new instance of StringDifferenceOptions with the specified options.

Top

Properties

	Name	Description
	ContinueProcessingPredicate	An optional predicate that allows clients to cancel differencing before it has completely finished.
	DetermineLocalityCallback	An optional callback to override the locality for a specific round of differencing.
	DifferenceType	The type of string differencing to do, as a combination of line, word, and character differencing.
	IgnoreTrimWhiteSpace	Gets or sets whether to ignore white space.
	Locality	The greatest distance a differencing element (line, span, or character) can move and still be considered part of the same source.
	WordSplitBehavior	The behavior to use when splitting words, if word differencing is requested by the DifferenceType.

Top

Methods

	Name	Description
	Equals	Determines whether two StringDifferenceOptions are the same. (Overrides ValueType.Equals(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	Provides a hash function for the type. (Overrides ValueType.GetHashCode().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Provides a string representation of these difference options. (Overrides ValueType.ToString().)

Top

Operators

	Name	Description
	Equality	Determines whether two StringDifferenceOptions are the same
	Inequality	Determines whether two StringDifferenceOptions are different.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Text.Differencing Namespace