English | 日本語
Home > Merge > Merge for Windows > Documentation Contents > TextComparison Object

TextComparison Object

This object represents a text file comparison window. The window isn’t necessarily visible on screen and can be used either to perform file comparison services for a client, or to present file comparisons on the screen to the user.

Use the methods and properties exposed by this object to perform text file comparisons, extract results, and to alter the appearance of a text file comparison window.

Properties (implemented by interface ICommonUI)

Active

IDL [propget] HRESULT Active([out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT Active([in] VARIANT_BOOL newValue)
.NET Boolean Active[get, set]
VB6 Active As Boolean

The active state of the comparison window.

The property is read/write.

Height

IDL [propget] HRESULT Height([out, retval] long* pValue)
[propput] HRESULT Height([in] long newValue)
.NET Int32 Height[get, set]
VB6 Height As Long

The height of the comparison window in pixels.

The property is read/write.

Left

IDL [propget] HRESULT Left([out, retval] long* pValue)
[propput] HRESULT Left([in] long newValue)
.NET Int32 Left[get, set]
VB6 Left As Long

The location of the left edge pixel coordinate of the comparison window.

The property is read/write.

Maximized

IDL [propget] HRESULT Maximized([out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT Maximized([in] VARIANT_BOOL newValue)
.NET Boolean Maximized[get, set]
VB6 Maximized As Boolean

The maximized state of the comparison window.

The property is read/write.

Minimized

IDL [propget] HRESULT Minimized([out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT Minimized([in] VARIANT_BOOL newValue)
.NET Boolean Minimized[get, set]
VB6 Minimized As Boolean

The minimized state of the comparison window.

The property is read/write.

Top

IDL [propget] HRESULT Top([out, retval] long* pValue)
[propput] HRESULT Top([in] long newValue)
.NET Int32 Top[get, set]
VB6 Top As Long

The location of the top edge pixel coordinate of the comparison window.

The property is read/write.

Visible

IDL [propget] HRESULT Visible([out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT Visible([in] VARIANT_BOOL newValue)
.NET Boolean Visible[get, set]
VB6 Visible As Boolean

The visible state of the comparison window.

The property is read/write.

Width

IDL [propget] HRESULT Width([out, retval] long* pValue)
[propput] HRESULT Width([in] long newValue)
.NET Int32 Width[get, set]
VB6 Width As Long

The width of the comparison window in pixels.

The property is read/write.

Properties (implemented by interface IComparison)

ViewType

IDL [propget] HRESULT ViewType([out, retval] FileViewType* pValue)
[propput] HRESULT ViewType([in] FileViewType newValue)
.NET FileViewType ViewType[get, set]
VB6 ViewType As FileViewType

The comparison type (two way or three way layout).

The property is read/write.

Properties (implemented by interface IFileComparison)

AllUnresolvedConflicts

IDL [propget] HRESULT AllUnresolvedConflicts([out, retval] long* pValue)
.NET Int32 AllUnresolvedConflicts[get]
VB6 AllUnresolvedConflicts As Long

Provides a count of the unresolved conflicts in all files in the comparison.

The property is read-only.

AutoSaveOnClose

IDL [propget] HRESULT AutoSaveOnClose([out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT AutoSaveOnClose([in] VARIANT_BOOL newValue)
.NET Boolean AutoSaveOnClose[get, set]
VB6 AutoSaveOnClose As Boolean

Normally, if Merge is closed when some modified files are unsaved, it will ask the user whether those files should be saved (unless the PromptForUnsavedFiles property is set to false, in which case any unsaved files will be discarded). However, if AutoSaveOnClose is set to true, Merge will automatically save any unsaved files without prompting the user. This feature can sometimes be useful when integrating Merge with other applications.

The property is read/write.

ComparisonError

IDL [propget] HRESULT ComparisonError([in, optional] VARIANT nFilePair, [out, retval] FileComparisonError* pValue)
.NET FileComparisonError get_ComparisonError(Object nFilePair)
VB6 ComparisonError( [nFilePair As Variant]) As FileComparisonError

The error (if any) that was encountered by the Compare method.

The property is read-only.

Arguments

ComparisonResult

IDL [propget] HRESULT ComparisonResult([in, optional] VARIANT nFilePair, [out, retval] FileComparisonResult* pValue)
.NET FileComparisonResult get_ComparisonResult(Object nFilePair)
VB6 ComparisonResult( [nFilePair As Variant]) As FileComparisonResult

The result (fcrSame, fcrDifferent, fcrError) of the comparison performed by the Compare method.

The property is read-only.

Arguments

ErrorInfo

IDL [propget] HRESULT ErrorInfo([in] short nFile, [out, retval] BSTR* pValue)
[propput] HRESULT ErrorInfo([in] short nFile, [in] BSTR newValue)
.NET String get_ErrorInfo(Int16 nFile)
void set_ErrorInfo(Int16 nFile, String newValue)
VB6 ErrorInfo(nFile As Integer) As String

Provides detailed information about errors encountered while loading/comparing one of the files. If nFile is -1, then errors that applied to all three files (for example, out of memory errors) are returned.

The property is read/write.

Arguments

Modified

IDL [propget] HRESULT Modified([in] short nFile, [out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT Modified([in] short nFile, [in] VARIANT_BOOL newValue)
.NET Boolean get_Modified(Int16 nFile)
void set_Modified(Int16 nFile, Boolean newValue)
VB6 Modified(nFile As Integer) As Boolean

Enables the modified state of a file to be set or retrieved.

The property is read/write.

Arguments

NumberOfChanges

IDL [propget] HRESULT NumberOfChanges([in, optional] VARIANT nFilePair, [out, retval] long* pValue)
.NET Int32 get_NumberOfChanges(Object nFilePair)
VB6 NumberOfChanges( [nFilePair As Variant]) As Long

The number of changes between two files. Use this property and the ChangeType, ChangeStartLine, and ChangeLength properties to iterate through the changes between the compared files. Note that the set of changes will include unchanged blocks of lines as well as removed, inserted, and changed blocks of lines.

The property is read-only.

Arguments

PromptForUnsavedFiles

IDL [propget] HRESULT PromptForUnsavedFiles([out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT PromptForUnsavedFiles([in] VARIANT_BOOL newValue)
.NET Boolean PromptForUnsavedFiles[get, set]
VB6 PromptForUnsavedFiles As Boolean

If a file comparison window containing modified files is closed, Merge will normally provide an opportunity to save them. Setting this property to false will prevent the Save Changes window from appearing.

See also the AutoSaveOnClose property.

The property is read/write.

ReadOnly

IDL [propget] HRESULT ReadOnly([in] short nFile, [out, retval] VARIANT_BOOL* pValue)
[propput] HRESULT ReadOnly([in] short nFile, [in] VARIANT_BOOL newValue)
.NET Boolean get_ReadOnly(Int16 nFile)
void set_ReadOnly(Int16 nFile, Boolean newValue)
VB6 ReadOnly(nFile As Integer) As Boolean

Enables the read-only state of a file to be set or retrieved.

The property is read/write.

Arguments

SaveFileName

IDL [propget] HRESULT SaveFileName([out, retval] BSTR* pValue)
[propput] HRESULT SaveFileName([in] BSTR newValue)
.NET String SaveFileName[get, set]
VB6 SaveFileName As String

The filename to use when saving changes (with Ctrl+S or a Save command) in the file comparison window.

The property is read/write.

ThreeWayMergeActions

IDL [propget] HRESULT ThreeWayMergeActions([out, retval] IThreeWayMergeActions** pValue)
.NET ThreeWayMergeActions ThreeWayMergeActions[get]
VB6 ThreeWayMergeActions As ThreeWayMergeActions

Retrieves a collection of actions that need to be performed to merge changes from the first and third files into the central common ancestor file.

The property is read-only.

UnresolvedConflicts

IDL [propget] HRESULT UnresolvedConflicts([in] short nFile, [out, retval] long* pValue)
.NET Int32 get_UnresolvedConflicts(Int16 nFile)
VB6 UnresolvedConflicts(nFile As Integer) As Long

Provides a count of the unresolved conflicts in one of the files in the comparison.

The property is read-only.

Arguments

Properties (implemented by interface ITextComparison)

ChangeLength

IDL [propget] HRESULT ChangeLength([in] long nChange, [in] long nSide, [in, optional] VARIANT nFilePair, [out, retval] long* pValue)
.NET Int32 get_ChangeLength(Int32 nChange, Int32 nSide, Object nFilePair)
VB6 ChangeLength(nChange As Long, nSide As Long [, nFilePair As Variant]) As Long

The number of lines in a change.

The property is read-only.

Arguments

ChangeStartLine

IDL [propget] HRESULT ChangeStartLine([in] long nChange, [in] long nSide, [in, optional] VARIANT nFilePair, [out, retval] long* pValue)
.NET Int32 get_ChangeStartLine(Int32 nChange, Int32 nSide, Object nFilePair)
VB6 ChangeStartLine(nChange As Long, nSide As Long [, nFilePair As Variant]) As Long

The starting line number (0 based) of a change.

The property is read-only.

Arguments

ChangeType

IDL [propget] HRESULT ChangeType([in] long nChange, [in, optional] VARIANT nFilePair, [out, retval] ChangeStyle* pValue)
.NET ChangeStyle get_ChangeType(Int32 nChange, Object nFilePair)
VB6 ChangeType(nChange As Long [, nFilePair As Variant]) As ChangeStyle

The type of a change. A change represents a block of inserted, removed, changed, or unchanged lines.

The property is read-only.

Arguments

FileContent

IDL [propget] HRESULT FileContent([in] short nFile, [out, retval] BSTR* pValue)
[propput] HRESULT FileContent([in] short nFile, [in] BSTR newValue)
.NET String get_FileContent(Int16 nFile)
void set_FileContent(Int16 nFile, String newValue)
VB6 FileContent(nFile As Integer) As String

Enables the content a file panel to get set or retrieved.

The property is read/write.

Arguments

FullLineData

IDL [propget] HRESULT FullLineData([in] long nLine, [in] short nFile, [out, retval] BSTR* pValue)
.NET String get_FullLineData(Int32 nLine, Int16 nFile)
VB6 FullLineData(nLine As Long, nFile As Integer) As String

The contents of a line within one of the files. The content includes CR and/or LF line ending characters.

The property is read-only.

Arguments

FullLineLength

IDL [propget] HRESULT FullLineLength([in] long nLine, [in] short nFile, [out, retval] long* pValue)
.NET Int32 get_FullLineLength(Int32 nLine, Int16 nFile)
VB6 FullLineLength(nLine As Long, nFile As Integer) As Long

The length of a line within one of the files. The length includes CR and/or LF line ending characters.

The property is read-only.

Arguments

LineData

IDL [propget] HRESULT LineData([in] long nLine, [in] short nFile, [out, retval] BSTR* pValue)
.NET String get_LineData(Int32 nLine, Int16 nFile)
VB6 LineData(nLine As Long, nFile As Integer) As String

The contents of a line within one of the files. The content does not include CR and/or LF line ending characters.

The property is read-only.

Arguments

LineLength

IDL [propget] HRESULT LineLength([in] long nLine, [in] short nFile, [out, retval] long* pValue)
.NET Int32 get_LineLength(Int32 nLine, Int16 nFile)
VB6 LineLength(nLine As Long, nFile As Integer) As Long

The length of a line within one of the files. The length does not include CR and/or LF line ending characters.

The property is read-only.

Arguments

NumberOfLines

IDL [propget] HRESULT NumberOfLines([in] short nFile, [out, retval] short* pValue)
.NET Int16 get_NumberOfLines(Int16 nFile)
VB6 NumberOfLines(nFile As Integer) As Integer

The number of lines in one of the compared files.

The property is read-only.

Arguments

Methods (implemented by interface ICommonUI)

Close

IDL HRESULT Close()
.NET void Close()
VB6 Close

Closes the comparison window.

GiveUserControl

IDL HRESULT GiveUserControl()
.NET void GiveUserControl()
VB6 GiveUserControl

Gives control over the lifetime of the comparison window to the user. Merge will not automatically close the window when outstanding automation references are released.

Restore

IDL HRESULT Restore()
.NET void Restore()
VB6 Restore

Restores the comparison window from minimized or maximised state to its normal resizable state.

Methods (implemented by interface IComparison)

Compare

IDL HRESULT Compare([in] VARIANT strFirstFile, [in] VARIANT strSecondFile, [in, optional] VARIANT strThirdFile)
.NET void Compare(Object strFirstFile, Object strSecondFile, Object strThirdFile)
VB6 Compare(strFirstFile As Variant, strSecondFile As Variant [, strThirdFile As Variant])

Compares two or three files. This method is synchronous. An event ComparisonComplete is fired when the comparison is finished to report errors and results.

Arguments

Print

IDL HRESULT Print([in] VARIANT_BOOL bShowPrinterDialog, [in] PageOrientation nOrientation)
.NET void Print(Boolean bShowPrinterDialog, PageOrientation nOrientation)
VB6 Print(bShowPrinterDialog As Boolean, nOrientation As PageOrientation)

Prints the file comparison.

Arguments

Refresh

IDL HRESULT Refresh()
.NET void Refresh()
VB6 Refresh

Recompares the files displayed in the window. This will cause any unsaved changes to be discarded.

Report

IDL HRESULT Report([in] BSTR bstrReporter, [in] LineEndingStyle nLineEndingStyle, [in] BSTR strOutputFile)
.NET void Report(String bstrReporter, LineEndingStyle nLineEndingStyle, String strOutputFile)
VB6 Report(bstrReporter As String, nLineEndingStyle As LineEndingStyle, strOutputFile As String)

Generates a report for the file comparison.

Arguments

Report2

IDL HRESULT Report2([in] BSTR bstrReporter, [in] LineEndingStyle nLineEndingStyle, [in] VARIANT vtEncoding, [in] BSTR strOutputFile)
.NET void Report2(String bstrReporter, LineEndingStyle nLineEndingStyle, Object vtEncoding, String strOutputFile)
VB6 Report2(bstrReporter As String, nLineEndingStyle As LineEndingStyle, vtEncoding As Variant, strOutputFile As String)

Generates a report for the file comparison.

Arguments

SaveComparison

IDL HRESULT SaveComparison([in] BSTR filename)
.NET void SaveComparison(String filename)
VB6 SaveComparison(filename As String)

Saves the comparison to a file. We recommend that you use the .cmp7 extension in the filename.

Arguments

SetPanelTitles

IDL HRESULT SetPanelTitles([in] VARIANT strFirst, [in] VARIANT strSecond, [in, optional] VARIANT strThird)
.NET void SetPanelTitles(Object strFirst, Object strSecond, Object strThird)
VB6 SetPanelTitles(strFirst As Variant, strSecond As Variant [, strThird As Variant])

Sets the titles shown above the file panels.

Arguments

Methods (implemented by interface IFileComparison)

CompareAsync

IDL HRESULT CompareAsync([in] VARIANT strFirstFile, [in] VARIANT strSecondFile, [in, optional] VARIANT strThirdFile)
.NET void CompareAsync(Object strFirstFile, Object strSecondFile, Object strThirdFile)
VB6 CompareAsync(strFirstFile As Variant, strSecondFile As Variant [, strThirdFile As Variant])

Compares two or three files. This method is asynchronous (returns before the comparison completes). An event ComparisonComplete is fired when the comparison is finished to report errors and results.

Arguments

SaveFile

IDL HRESULT SaveFile([in] short nFile, [in, optional] VARIANT strSaveTo)
.NET void SaveFile(Int16 nFile, Object strSaveTo)
VB6 SaveFile(nFile As Integer [, strSaveTo As Variant])

Saves the file in the nFile panel. If the strSaveTo argument is provided, Merge performs a Save As to the specified file.

Arguments

SaveFileAs

IDL HRESULT SaveFileAs([in] short nFile)
.NET void SaveFileAs(Int16 nFile)
VB6 SaveFileAs(nFile As Integer)

Prompts the user to save the file in the nFile panel with a new name.

Arguments

ThreeWayMerge

IDL HRESULT ThreeWayMerge([out, retval] long* pValue)
.NET Int32 ThreeWayMerge()
VB6 ThreeWayMerge As Long

Merges the two outer files in a three-way comparison into the central common ancestor file. The number of merging conflicts encountered during the merge is returned.

Methods (implemented by interface ITextComparison)

Methods (implemented by interface ITextComparison2)

CompareAsyncWithEncoding

IDL HRESULT CompareAsyncWithEncoding([in] VARIANT strFirstFile, [in] IEncoding* firstEncoding, [in] VARIANT strSecondFile, [in] IEncoding* secondEncoding, [in, optional] VARIANT strThirdFile, [in, optional] IEncoding* thirdEncoding)
.NET void CompareAsyncWithEncoding(Object strFirstFile, Encoding firstEncoding, Object strSecondFile, Encoding secondEncoding, Object strThirdFile, Encoding thirdEncoding)
VB6 CompareAsyncWithEncoding(strFirstFile As Variant, firstEncoding As Encoding, strSecondFile As Variant, secondEncoding As Encoding [, strThirdFile As Variant] [, thirdEncoding As Encoding])

Compares two or three files, using the specified encodings when loading the files. This method is asynchronous (returns before the comparison completes). An event ComparisonComplete is fired when the comparison is finished to report errors and results.

Arguments

CompareWithEncoding

IDL HRESULT CompareWithEncoding([in] VARIANT strFirstFile, [in] IEncoding* firstEncoding, [in] VARIANT strSecondFile, [in] IEncoding* secondEncoding, [in, optional] VARIANT strThirdFile, [in, optional] IEncoding* thirdEncoding)
.NET void CompareWithEncoding(Object strFirstFile, Encoding firstEncoding, Object strSecondFile, Encoding secondEncoding, Object strThirdFile, Encoding thirdEncoding)
VB6 CompareWithEncoding(strFirstFile As Variant, firstEncoding As Encoding, strSecondFile As Variant, secondEncoding As Encoding [, strThirdFile As Variant] [, thirdEncoding As Encoding])

Compares two or three files, using the specified encodings when loading the files. This method is synchronous. An event ComparisonComplete is fired when the comparison is finished to report errors and results.

Arguments

Events (implemented by interface IFileComparisonEvents)

Close

IDL HRESULT Close()
.NET void Close()
VB6 Close

The file comparison window was closed by the user.

ComparisonComplete

IDL HRESULT ComparisonComplete([in] FileComparisonError error1, [in] FileComparisonResult result1, [in, optional] FileComparisonError error2, [in, optional] FileComparisonResult result2)
.NET void ComparisonComplete(FileComparisonError error1, FileComparisonResult result1, FileComparisonError error2, FileComparisonResult result2)
VB6 ComparisonComplete(error1 As FileComparisonError, result1 As FileComparisonResult [, error2 As FileComparisonError] [, result2 As FileComparisonResult])

Occurs when a file comparison completes. For comparisons between two files, only the first two arguments are defined. For comparisons between three files, all four arguments are defined.

Arguments


Related topics