このオブジェクトは、テキスト ファイル比較ウィンドウを表します。必ずしも画面にウィンドウを表示する必要はありませんが、クライアントにファイル比較サービスを実行したり、ファイル比較画面をユーザーに提示したりする場合に、このウィンドウを利用できます。
このオブジェクトが公開するメソッドとプロパティを使って、テキスト ファイルの比較、結果の抽出、テキスト ファイル比較ウィンドウの外観の変更を行います。
このオブジェクトによって表される比較が閉じると、Close イベントのハンドラーによって、メソッドやプロパティにアクセスする最後の機会が提供されます。その後はアクセスしようとすると、エラーになります。
プロパティ
Active読み取り/書き込みICommonUI
比較ウィンドウのアクティブ状態。
IDL |
[propget] HRESULT Active([out, retval] VARIANT_BOOL* pValue)
|
---|---|
.NET | Boolean Active[get, set] |
AllUnresolvedConflicts読み取り専用IFileComparison
すべての比較ファイルの中にある未解決の不一致の数を提供します。
IDL |
[propget] HRESULT AllUnresolvedConflicts([out, retval] long* pValue)
|
---|---|
.NET | Int32 AllUnresolvedConflicts[get] |
AutoSaveOnClose読み取り/書き込みIFileComparison
Merge が閉じられるときに変更されたファイルが未保存の場合、通常、Merge はユーザーにこれらのファイルを保存するかどうかを尋ねます。これは PromptForUnsavedFiles
が false
に設定されていない場合に限ります。設定されている場合は、未保存ファイルが破棄されます。ただし、AutoSaveOnClose
が true
に設定されている場合、Merge はユーザーに尋ねることなく未保存ファイルを自動的に保存します。この機能は、Merge をほかのアプリケーションと統合する場合に便利です。
IDL |
[propget] HRESULT AutoSaveOnClose([out, retval] VARIANT_BOOL* pValue)
|
---|---|
.NET | Boolean AutoSaveOnClose[get, set] |
ChangeLength読み取り専用ITextComparison
変更の行数。
IDL |
[propget] HRESULT ChangeLength(
|
---|---|
.NET | Int32
get_ChangeLength( |
nChange
含まれている行数を求める変更(0 ベース)を指定します。この値は 0 からNumberOfChanges-1
の範囲になります。nSide
変更の左側(0)または右側(1)を指定します。nFilePair
オプション
ファイル 0 と 1 の結果を返すか(nFilePair = 0
、デフォルトの場合)、ファイル 1 と 2 の結果を返すか(nFilePair = 1
の場合)を指定します。
ChangeStartLine読み取り専用ITextComparison
変更の開始行(0 ベース)。
IDL |
[propget] HRESULT ChangeStartLine(
|
---|---|
.NET | Int32
get_ChangeStartLine( |
nChange
開始行を求める変更(0 ベース)を指定します。この値は 0 からNumberOfChanges-1
の範囲になります。nSide
変更の左側(0)または右側(1)を指定します。nFilePair
オプション
ファイル 0 と 1 の結果を返すか(nFilePair = 0
、デフォルトの場合)、ファイル 1 と 2 の結果を返すか(nFilePair = 1
の場合)を指定します。
ChangeType読み取り専用ITextComparison
変更のタイプ。変更は、挿入行、削除行、変更行、未変更行を表します。
IDL |
[propget] HRESULT ChangeType(
|
---|---|
.NET | ChangeStyle
get_ChangeType( |
nChange
タイプを求める変更(0 ベース)を指定します。この値は 0 からNumberOfChanges-1
の範囲になります。nFilePair
オプション
ファイル 0 と 1 の結果を返すか(nFilePair = 0
、デフォルトの場合)、ファイル 1 と 2 の結果を返すか(nFilePair = 1
の場合)を指定します。
ComparisonError読み取り専用IFileComparison
Compare
メソッドで発生したエラー(ある場合)。
IDL |
[propget] HRESULT ComparisonError(
|
---|---|
.NET | FileComparisonError
get_ComparisonError( |
nFilePair
オプション
ファイル 0 と 1 の結果を返すか(nFilePair = 0
、デフォルトの場合)、ファイル 1 と 2 の結果を返すか(nFilePair = 1
の場合)を指定します。
ComparisonResult読み取り専用IFileComparison
Compare
メソッドで実行された比較の結果(fcrSame
、fcrDifferent
、fcrError
)。
IDL |
[propget] HRESULT ComparisonResult(
|
---|---|
.NET | FileComparisonResult
get_ComparisonResult( |
nFilePair
オプション
ファイル 0 と 1 の結果を返すか(nFilePair = 0
、デフォルトの場合)、ファイル 1 と 2 の結果を返すか(nFilePair = 1
の場合)を指定します。
ErrorInfo読み取り/書き込みIFileComparison
ファイルの 1 つを読み込み/比較している間に発生したエラーに関する詳細情報を提供します。nFile
が -1
の場合、3 つのファイルすべてに適用されるエラー(メモリ不足エラーなど)が返されます。
IDL |
[propget] HRESULT ErrorInfo(
|
---|---|
.NET | String
get_ErrorInfo( |
nFile
エラー情報を取得するファイル(0、1、または 2)。値を-1
にすると、すべてのファイルを示すことができます。
FileContent読み取り/書き込みITextComparison
ファイル ペインの内容の設定、取得、あるいは検索を可能にします。
IDL |
[propget] HRESULT FileContent(
|
---|---|
.NET | String
get_FileContent( |
nFile
行を含んでいるファイル(0、1、または 2)を指定します。
FullLineData読み取り専用ITextComparison
ファイルの 1 つにある行の内容。内容には CR
や LF
の行終端文字が含まれます。
IDL |
[propget] HRESULT FullLineData(
|
---|---|
.NET | String
get_FullLineData( |
nLine
データを求める行(0 ベース)を指定します。nFile
行を含んでいるファイル(0、1、または 2)を指定します。
FullLineLength読み取り専用ITextComparison
ファイルの 1 つにある行の長さ。長さには CR
や LF
の行終端文字が含まれます。
IDL |
[propget] HRESULT FullLineLength(
|
---|---|
.NET | Int32
get_FullLineLength( |
nLine
長さを求める行(0 ベース)を指定します。nFile
行を含んでいるファイル(0、1、または 2)を指定します。
Height読み取り/書き込みICommonUI
比較ウィンドウの高さ(ピクセル)。
IDL |
[propget] HRESULT Height([out, retval] long* pValue)
|
---|---|
.NET | Int32 Height[get, set] |
Left読み取り/書き込みICommonUI
比較ウィンドウの左端のピクセル座標の位置。
IDL |
[propget] HRESULT Left([out, retval] long* pValue)
|
---|---|
.NET | Int32 Left[get, set] |
LineData読み取り専用ITextComparison
ファイルの 1 つにある行の内容。内容には CR
や LF
の行終端文字は含まれません。
IDL |
[propget] HRESULT LineData(
|
---|---|
.NET | String
get_LineData( |
nLine
データを求める行(0 ベース)を指定します。nFile
行を含んでいるファイル(0、1、または 2)を指定します。
LineLength読み取り専用ITextComparison
ファイルの 1 つにある行の長さ。長さには CR
や LF
の行終端文字は含まれません。
IDL |
[propget] HRESULT LineLength(
|
---|---|
.NET | Int32
get_LineLength( |
nLine
長さを求める行(0 ベース)を指定します。nFile
行を含んでいるファイル(0、1、または 2)を指定します。
Maximized読み取り/書き込みICommonUI
比較ウィンドウの最大化状態。
IDL |
[propget] HRESULT Maximized([out, retval] VARIANT_BOOL* pValue)
|
---|---|
.NET | Boolean Maximized[get, set] |
Minimized読み取り/書き込みICommonUI
比較ウィンドウの最小化状態。
IDL |
[propget] HRESULT Minimized([out, retval] VARIANT_BOOL* pValue)
|
---|---|
.NET | Boolean Minimized[get, set] |
Modified読み取り/書き込みIFileComparison
ファイルの修正状態の設定または取得を可能にします。
IDL |
[propget] HRESULT Modified(
|
---|---|
.NET | Boolean
get_Modified( |
nFile
修正状態を取得/設定するファイル(0、1、または 2)。
NumberOfChanges読み取り専用IFileComparison
2 つのファイル間の変更数。このプロパティと ChangeType
、ChangeStartLine
、および ChangeLength
プロパティを使用して、比較ファイル間の変更を繰り返し処理します。変更のセットには、削除/挿入/変更ブロック行のほかに未変更のブロック行も含まれることに留意してください。
IDL |
[propget] HRESULT NumberOfChanges(
|
---|---|
.NET | Int32
get_NumberOfChanges( |
nFilePair
オプション
ファイル 0 と 1 の結果を返すか(nFilePair = 0
、デフォルトの場合)、ファイル 1 と 2 の結果を返すか(nFilePair = 1
の場合)を指定します。
NumberOfLines読み取り専用ITextComparison
比較ファイルのうちの 1 つの行数。
IDL |
[propget] HRESULT NumberOfLines(
|
---|---|
.NET | Int16
get_NumberOfLines( |
nFile
対象のファイルを指定します(第 1、第 2、第 3 ファイルに対してそれぞれ 0、1、または 2)。
PromptForUnsavedFiles読み取り/書き込みIFileComparison
修正されたファイルを含んでいるファイル比較ウィンドウが閉じられる場合、通常、Merge はそれらのファイルを保存する機会を提供します。このプロパティを false
に設定すると、[’修正ファイルの保存]ウィンドウは表示されなくなります。AutoSaveOnClose
プロパティも参照してください。
IDL |
[propget] HRESULT PromptForUnsavedFiles([out, retval] VARIANT_BOOL* pValue)
|
---|---|
.NET | Boolean PromptForUnsavedFiles[get, set] |
ReadOnly読み取り/書き込みIFileComparison
ファイルの読み取り専用状態の設定または取得を可能にします。
IDL |
[propget] HRESULT ReadOnly(
|
---|---|
.NET | Boolean
get_ReadOnly( |
nFile
読み取り専用状態を取得/設定するファイル(0、1、または 2)。
SaveFileName読み取り/書き込みIFileComparison
テキスト比較ウィンドウで変更を保存(Ctrl+S または[上書き保存]コマンドを使用)するときに使うファイル名。
IDL |
[propget] HRESULT SaveFileName([out, retval] BSTR* pValue)
|
---|---|
.NET | String SaveFileName[get, set] |
ThreeWayMergeActions読み取り専用IFileComparison
1 番目と 3 番目のファイルの変更を中央の親ファイルへマージするために実行する必要があるアクションのコレクションを取得します。
IDL |
[propget] HRESULT ThreeWayMergeActions([out, retval] IThreeWayMergeActions** pValue)
|
---|---|
.NET | ThreeWayMergeActions ThreeWayMergeActions[get] |
Top読み取り/書き込みICommonUI
比較ウィンドウの上端のピクセル座標の位置。
IDL |
[propget] HRESULT Top([out, retval] long* pValue)
|
---|---|
.NET | Int32 Top[get, set] |
UnresolvedConflicts読み取り専用IFileComparison
比較ファイルの 1 つの中にある未解決の不一致の数を提供します。
IDL |
[propget] HRESULT UnresolvedConflicts(
|
---|---|
.NET | Int32
get_UnresolvedConflicts( |
nFile
未解決の不一致をチェックする必要のあるファイル(0、1、または 2)を指定します。
ViewType読み取り/書き込みIComparison
比較タイプ(2 者間または 3 者間レイアウト)。
IDL |
[propget] HRESULT ViewType([out, retval] FileViewType* pValue)
|
---|---|
.NET | FileViewType ViewType[get, set] |
Visible読み取り/書き込みICommonUI
比較ウィンドウの表示状態。
IDL |
[propget] HRESULT Visible([out, retval] VARIANT_BOOL* pValue)
|
---|---|
.NET | Boolean Visible[get, set] |
Width読み取り/書き込みICommonUI
比較ウィンドウの幅(ピクセル)。
IDL |
[propget] HRESULT Width([out, retval] long* pValue)
|
---|---|
.NET | Int32 Width[get, set] |
メソッド
CloseICommonUI
比較ウィンドウを閉じます。
IDL |
HRESULT Close()
|
---|---|
.NET | void Close() |
CompareIComparison
2 つまたは 3 つのファイルを比較します。このメソッドは同期メソッドです。比較が完了して、エラーと結果を報告するときに ComparisonComplete
イベントが発生します。
IDL |
HRESULT Compare(
|
---|---|
.NET | void Compare( |
strFirstFile
第 1 ファイルへの完全修飾パス。strSecondFile
第 2 ファイルへの完全修飾パス。strThirdFile
オプション
第 3 ファイルへの完全修飾パス。
CompareAsyncIFileComparison
2 つまたは 3 つのファイルを比較します。このメソッドは非同期メソッドです(比較が完了する前に返されます)。比較が完了して、エラーと結果を報告するときに ComparisonComplete
イベントが発生します。
IDL |
HRESULT CompareAsync(
|
---|---|
.NET | void CompareAsync( |
strFirstFile
第 1 ファイルへの完全修飾パス。strSecondFile
第 2 ファイルへの完全修飾パス。strThirdFile
オプション
第 3 ファイルへの完全修飾パス。
CompareAsyncWithEncodingITextComparison2
ファイルを読み込む際、指定されたエンコードを使用して、2 つまたは 3 つのファイルを比較します。このメソッドは非同期メソッドです(比較が完了する前に返されます)。比較が完了して、エラーと結果を報告するときに ComparisonComplete
イベントが発生します。
IDL |
HRESULT CompareAsyncWithEncoding(
|
---|---|
.NET | void CompareAsyncWithEncoding( |
strFirstFile
第 1 ファイルへの完全修飾パス。firstEncoding
第 1 ファイルを読み込む際に使用するエンコード、またはデフォルトのエンコードを使用する場合は 0(nullNULL
)。strSecondFile
第 2 ファイルへの完全修飾パス。secondEncoding
第 2 ファイルを読み込む際に使用するエンコード、またはデフォルトのエンコードを使用する場合は 0(nullNULL
)。strThirdFile
オプション
第 3 ファイルへの完全修飾パス。thirdEncoding
オプション
第 3 ファイルを読み込む際に使用するエンコード、またはデフォルトのエンコードを使用する場合は 0(nullNULL
)。
CompareWithEncodingITextComparison2
ファイルを読み込む際、指定されたエンコードを使用して、2 つまたは 3 つのファイルを比較します。このメソッドは同期メソッドです。比較が完了して、エラーと結果を報告するときに ComparisonComplete
イベントが発生します。
IDL |
HRESULT CompareWithEncoding(
|
---|---|
.NET | void CompareWithEncoding( |
strFirstFile
第 1 ファイルへの完全修飾パス。firstEncoding
第 1 ファイルを読み込む際に使用するエンコード、またはデフォルトのエンコードを使用する場合は 0(nullNULL
)。strSecondFile
第 2 ファイルへの完全修飾パス。secondEncoding
第 2 ファイルを読み込む際に使用するエンコード、またはデフォルトのエンコードを使用する場合は 0(nullNULL
)。strThirdFile
オプション
第 3 ファイルへの完全修飾パス。thirdEncoding
オプション
第 3 ファイルを読み込む際に使用するエンコード、またはデフォルトのエンコードを使用する場合は 0(nullNULL
)。
GiveUserControlICommonUI
比較ウィンドウの起動から終了までをユーザーが制御できるようにします。未処理のオートメーション参照が解放されても、Merge は自動的に比較ウィンドウを閉じません。
IDL |
HRESULT GiveUserControl()
|
---|---|
.NET | void GiveUserControl() |
PrintIComparison
ファイル比較を印刷します。
IDL |
HRESULT Print(
|
---|---|
.NET | void Print( |
bShowPrinterDialog
デフォルトはfalse
です。印刷を行う前に印刷ダイアログをユーザーに表示するかどうかを示します。nOrientation
デフォルトはpoLandscape
です。縦置き、横置きのどちらの向きで印刷するかを示します。
RefreshIComparison
ウィンドウに表示されているファイルを再度比較します。これにより、未保存の変更は破棄されます。
IDL |
HRESULT Refresh()
|
---|---|
.NET | void Refresh() |
ReportIComparison
ファイル比較のレポートを生成します。
IDL |
HRESULT Report(
|
---|---|
.NET | void Report( |
bstrReporter
レポートの生成に使用するレポーターのショート ネーム。有効なショート ネームはxml
、html
、htmlslideshow
、およびdiff
です。すべてのレポーターで 3 者間比較レポートの生成がサポートされているわけではないことに留意してください。nLineEndingStyle
生成するレポート ファイルで使用する行終端のタイプ。strOutputFile
レポート用の出力ファイルの名前。レポーターが 2 つ以上のファイルを生成する場合、それらのファイルにはこの名前を基にした名前が付けられます。
Report2IComparison
ファイル比較のレポートを生成します。
IDL |
HRESULT Report2(
|
---|---|
.NET | void Report2( |
bstrReporter
レポートの生成に使用するレポーターのショート ネーム。有効なショート ネームは “xml”、“html”、“htmlslideshow” および “diff” です。すべてのレポーターで 3 者間比較レポートの生成がサポートされているわけではないことに留意してください。nLineEndingStyle
生成するレポート ファイルで使用する行終端のタイプ。vtEncoding
生成するレポートで使用する文字エンコード。コード ページ番号、またはUCS2
(Unicode UCS2)、UCS2-BE
(Unicode UCS2 ビッグ エンディアン)、UTF8
(Unicode UTF8 バイト順マーク付き)、UTF8-NOBOM
(Unicode UTF8 バイト順マークなし)、UTF7
(Unicode UTF7)のいずれか。strOutputFile
レポート用の出力ファイルの名前。レポーターが 2 つ以上のファイルを生成する場合、それらのファイルにはこの名前を基にした名前が付けられます。
RestoreICommonUI
比較ウィンドウを、最小化または最大化された状態から通常のサイズ変更可能な状態に戻します。
IDL |
HRESULT Restore()
|
---|---|
.NET | void Restore() |
SaveComparisonIComparison
比較をファイルに保存します。ファイル名には .cmp7
拡張子を使用することをお勧めします。
IDL |
HRESULT SaveComparison(
|
---|---|
.NET | void SaveComparison( |
filename
比較を保存するファイルの名前。
SaveFileIFileComparison
nFile
パネルのファイルを保存します。strSaveTo
引数を使用すると、Merge は指定ファイルに対して名前を付けて保存を実行します。
IDL |
HRESULT SaveFile(
|
---|---|
.NET | void SaveFile( |
nFile
保存するファイル(0、1、または 2)。strSaveTo
オプション
ファイルを保存するときに使用する任意のファイル名。
SaveFileAsIFileComparison
nFile
パネルのファイルに新しい名前を付けて保存するようユーザーに指示するメッセージを表示します。
IDL |
HRESULT SaveFileAs(
|
---|---|
.NET | void SaveFileAs( |
nFile
保存するファイル(0、1、または 2)。
SetPanelTitlesIComparison
ファイル ペインの上に表示するタイトルを設定します。
IDL |
HRESULT SetPanelTitles(
|
---|---|
.NET | void SetPanelTitles( |
strFirst
第 1 ファイル ペインのタイトル。strSecond
第 2 ファイル ペインのタイトル。strThird
オプション
第 3 ファイル ペインのタイトル。
ThreeWayMergeIFileComparison
3 者間比較で 2 つの(左右)外側のファイルを中央にある共通の親ファイルにマージします。マージが返される間に発生したマージの不一致の数。
IDL |
HRESULT ThreeWayMerge([out, retval] long* pValue)
|
---|---|
.NET | Int32 ThreeWayMerge() |
イベント
CloseIFileComparisonEvents
ファイル比較ウィンドウはユーザーによって閉じられました。
IDL |
HRESULT Close()
|
---|---|
.NET | void Close() |
ComparisonCompleteIFileComparisonEvents
ファイル比較が完了したときに発生します。2 ファイル間での比較では、最初の 2 つの引数のみが定義されます。3 ファイル間での比較では、4 つすべての引数が定義されます。
IDL |
HRESULT ComparisonComplete(
|
---|---|
.NET | void ComparisonComplete( |
error1
第 1 ファイルと第 2 ファイルの比較中に発生したエラー(ある場合)。result1
第 1 ファイルと第 2 ファイルとの比較の結果。error2
オプション
第 2 ファイルと第 3 ファイルの比較中に発生したエラー(ある場合)。result2
オプション
第 2 ファイルと第 3 ファイルとの比較の結果。