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
Public method StringDifferenceOptions(StringDifferenceOptions) Initializes a new instance of StringDifferenceOptions with the specified options.
Public method StringDifferenceOptions(StringDifferenceTypes, Int32, Boolean) Initializes a new instance of StringDifferenceOptions with the specified options.

Top

Properties

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

Top

Methods

  Name Description
Public method Equals Determines whether two StringDifferenceOptions are the same. (Overrides ValueType.Equals(Object).)
Public method GetHashCode Provides a hash function for the type. (Overrides ValueType.GetHashCode.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString Provides a string representation of these difference options. (Overrides ValueType.ToString.)

Top

Operators

  Name Description
Public operatorStatic member Equality Determines whether two StringDifferenceOptions are the same
Public operatorStatic member 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