Share via


DiffOptions Class

The options that are available with performing diffs.

NOTE: This was copied almost verbatim from the old engine, because we already shipped this class.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.VersionControl.Common.DiffOptions

Namespace:  Microsoft.TeamFoundation.VersionControl.Common
Assembly:  Microsoft.TeamFoundation.VersionControl.Common (in Microsoft.TeamFoundation.VersionControl.Common.dll)

Syntax

'Declaration
Public Class DiffOptions
public class DiffOptions
public ref class DiffOptions
type DiffOptions =  class end
public class DiffOptions

The DiffOptions type exposes the following members.

Constructors

  Name Description
Public method DiffOptions Constructs a new DiffOptions instance

Top

Properties

  Name Description
Public property CodePageOverride Code page override from the command-line, non-zero means provide the override
Public property CommandLineOptions Command-line options to pass to a third-party tool
Public property ContextLines The number of lines of context to provide for output formats that use them.
Public property CultureInfo Returns the CultureInfo that should be used if any DiffOption flags require it.
Public property Flags The various flags that can be set for a difference operation.
Public property OutputType Output type to use
Public property Recursive Whether this diff should be recursive
Public property SourceEncoding The encoding of the source files.
Public property SourceLabel The string that should be used to label the source diff stream.
Public property StreamWriter Gets or sets the output stream writer.
Public property TargetEncoding The encoding of the output stream.
Public property TargetLabel The string that should be used to label the target diff stream.
Public property UseThirdPartyTool Whether this diff should attempt to start up a third-party tool
Public property VssFormatType Returns the VSS output subtype that will be used when formatting the output stream (if any at all). This property is strictly for backward compatibility purposes. This property defaults to VssOutputType.Vss as does the VSS command line.
Public property VssOutputWidth If this property is set then the VSS output will be adjusted to fit inside this width. When set to -1 none of the output is trimmed at all.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetCodePage Gets the code page override if available. Otherwise returns the provided fall-back code page.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SetTargetEncodingToConsole A helper method to set the target encoding to the encoding of the Console.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

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.TeamFoundation.VersionControl.Common Namespace