Win32 API 日本語リファレンス
ホームUI.Controls.RichEdit › ITextDocument2

ITextDocument2

COMIDispatch (デュアル)
IDispatch を実装(デュアルインターフェース)。HSP では comobj 経由でメソッド名による遅延バインド呼び出しができます(vtableインデックス不要)。
IIDc241f5e0-7206-11d8-a2c7-00a0d1d6c6b3継承元ITextDocument呼び出し名前(IDispatch) または vtbl自前メソッド開始 vtbl26

公式ドキュメント

ITextDocument インターフェイスを拡張し、Input Method Editor (IME) がリッチエディットコントロールを操作できるようにするメソッドや、ITextDisplays、ITextRange2、ITextFont2、ITextPara2 などの他のインターフェイスを取得するメソッドを追加します。

メソッド 44

vtbl = vtable インデックス(0始まり)。IDispatch 実装のため HSP ではメソッド名でも呼べます(上記)。低レベルの index 呼び出し用に vtbl も掲載。0〜2 は IUnknown。

vtbl 26 HRESULT GetCaretType(INT* pValue)

キャレットの種類を取得します。

pValueINT*out

キャレットの種類。次の値のいずれかを指定できます。

tomKoreanBlockCaret

tomNormalCaret

tomNullCaret

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 27 HRESULT SetCaretType(INT Value)

キャレットの種類を設定します。

ValueINTin

新しいキャレットの種類。次の値のいずれかを指定できます。

tomKoreanBlockCaret

tomNormalCaret

tomNullCaret

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 28 HRESULT GetDisplays(ITextDisplays** ppDisplays)

この Text Object Model (TOM) エンジンインスタンスの displays コレクションを取得します。

ppDisplaysITextDisplays**outdisplays コレクション。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

リッチエディットコントロールはこのメソッドを実装していません。

vtbl 29 HRESULT GetDocumentFont(ITextFont2** ppFont)

この Text Object Model (TOM) エンジンのインスタンスに対する既定の文字書式情報を提供するオブジェクトを取得します。

ppFontITextFont2**out既定の文字書式情報を提供するオブジェクト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 30 HRESULT SetDocumentFont(ITextFont2* pFont)

この Text Object Model (TOM) エンジンのインスタンスに対する既定の文字書式を設定します。

pFontITextFont2*inoptional既定の文字書式を提供するフォントオブジェクト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

既定の文字書式は、ITextFont::Reset(tomDefault) を呼び出して設定することもできます。

vtbl 31 HRESULT GetDocumentPara(ITextPara2** ppPara)

この Text Object Model (TOM) エンジンのインスタンスに対する既定の段落書式情報を提供するオブジェクトを取得します。

ppParaITextPara2**out既定の段落書式情報を提供するオブジェクト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 32 HRESULT SetDocumentPara(ITextPara2* pPara)

この Text Object Model (TOM) エンジンのインスタンスに対する既定の段落書式を設定します。

pParaITextPara2*inoptional既定の段落書式を提供する段落オブジェクト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

既定の段落書式は、ITextPara::Reset(tomDefault) を呼び出して設定することもできます。

vtbl 33 HRESULT GetEastAsianFlags(tomConstants* pFlags)

東アジアフラグを取得します。

pFlagstomConstants*out

東アジアフラグ。このパラメーターには、次の値の組み合わせを指定できます。

説明
tomRE10Mode
TOM バージョン 1.0 エミュレーションモード。
tomUseAtFont
CJK 縦書きテキストに @ フォントを使用します。
tomTextFlowMask
次の 4 つのテキスト方向のマスク:
tomTextFlowES
通常の左から右への横書きテキスト。
tomTextFlowSW
通常の東アジア縦書きテキスト。
tomTextFlowWN
代替の方向。
tomTextFlowNE
代替の方向。
tomUsePassword
パスワードコントロールを使用します。
tomNoIME
IME 操作をオフにします (ES_NOIME を参照)。
tomSelfIME
リッチエディットホストが IME 操作を処理します (ES_SELFIME を参照)。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 34 HRESULT GetGenerator(LPWSTR* pbstr)

Text Object Model (TOM) エンジンの名前を取得します。

pbstrLPWSTR*outTOM エンジンの名前。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 35 HRESULT SetIMEInProgress(INT Value)

Input Method Editor (IME) の処理中 (in-progress) フラグの状態を設定します。

ValueINTinIME 処理中フラグをオンにするには tomTrue を、オフにするには tomFalse を使用します。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 36 HRESULT GetNotificationMode(INT* pValue)

通知モードを取得します。

pValueINT*out通知モード。通知が有効な場合は tomTrue、そうでない場合は tomFalse が設定されます。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 37 HRESULT SetNotificationMode(INT Value)

通知モードを設定します。

ValueINTin通知モード。通知をオンにするには tomTrue を、オフにするには tomFalse を使用します。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 38 HRESULT GetSelection2(ITextSelection2** ppSel)

アクティブな選択範囲を取得します。(ITextDocument2.GetSelection2)

ppSelITextSelection2**outアクティブな選択範囲。リッチエディットコントロールがインプレースでアクティブでない場合、このパラメーターは NULL になります。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 39 HRESULT GetStoryRanges2(ITextStoryRanges2** ppStories)

ドキュメント内のストーリーを列挙するためのオブジェクトを取得します。

ppStoriesITextStoryRanges2**outストーリーを列挙するためのオブジェクト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このメソッドは、ITextDocument::GetStoryCount メソッドが 1 より大きい値を返す場合にのみ呼び出してください。

vtbl 40 HRESULT GetTypographyOptions(INT* pOptions)

タイポグラフィオプションを取得します。

pOptionsINT*out

次のタイポグラフィオプションの組み合わせ。

説明
TO_ADVANCEDTYPOGRAPHY
高度なタイポグラフィ (特殊な行分割と行書式設定) がオンになっています。
TO_SIMPLELINEBREAK
通常の行分割と書式設定が使用されます。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 41 HRESULT GetVersion(INT* pValue)

Text Object Model (TOM) エンジンのバージョン番号を取得します。

pValueINT*outバージョン番号。バイト 3 はメジャーバージョン番号、バイト 2 はマイナーバージョン番号を表し、下位 16 ビットはビルド番号を表します。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 42 HRESULT GetWindow(LONGLONG* pHwnd)

Text Object Model (TOM) エンジンが出力の表示に使用しているウィンドウのハンドルを取得します。

pHwndLONGLONG*outTOM エンジンが使用しているウィンドウのハンドル。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

リッチエディットコントロールは、TOM エンジンが使用しているウィンドウを所有している必要はありません。たとえば、リッチエディットコントロールはウィンドウレスの場合があります。

Input Method Editor (IME) は、キーボードメッセージを受信しているウィンドウのハンドルを必要とします。このメソッドはそのハンドルを取得します。

vtbl 43 HRESULT AttachMsgFilter(IUnknown* pFilter)

エディットインスタンスに新しいメッセージフィルターをアタッチします。エディットインスタンスが受信するすべてのウィンドウメッセージは、メッセージフィルターに転送されます。

pFilterIUnknown*inoptionalメッセージフィルター。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

メッセージフィルターは、使用する前にドキュメントにバインドする必要があります。

vtbl 44 HRESULT CheckTextLimit(INT cch, INT* pcch)

追加する文字数が最大テキスト制限を超えるかどうかを確認します。

cchINTin追加する文字数。
pcchINT*in最大テキスト制限を超える文字数。文字数が制限を超えない場合、このパラメーターは 0 になります。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 45 HRESULT GetCallManager(IUnknown** ppVoid)

call manager を取得します。

ppVoidIUnknown**outcall manager オブジェクト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

call manager オブジェクトは呼び出し元からは不透明です。Text Object Model (TOM) エンジンは、特定のシナリオにおける内部通知を処理するためにこのオブジェクトを使用します。

vtbl 46 HRESULT GetClientRect(tomConstants Type, INT* pLeft, INT* pTop, INT* pRight, INT* pBottom)

リッチエディットコントロールのクライアント領域の四角形を取得します。

TypetomConstantsin

クライアント領域の四角形取得オプション。次の値の組み合わせを指定できます。

説明
tomClientCoord
四角形をクライアント座標で取得します。この値を指定しない場合、関数はスクリーン座標を取得します。
tomIncludeInset
クライアント領域の四角形の左および上の座標に左および上のインセットを加算し、右および下の座標から右および下のインセットを減算します。
tomTransform
ホストアプリケーションが提供するワールド変換 (XFORM) を使用して、取得した四角形の座標を変換します。
pLeftINT*out四角形の左上隅の x 座標。
pTopINT*out四角形の左上隅の y 座標。
pRightINT*out四角形の右下隅の x 座標。
pBottomINT*out四角形の右下隅の y 座標。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 47 HRESULT GetEffectColor(INT Index, INT* pValue)

特殊なテキスト属性に使用される色を取得します。

IndexINTin

取得する色のインデックス。次の値のいずれかを指定できます。

インデックス 説明
0
テキストの色。
1
RGB(0, 0, 0)
2
RGB(0, 0, 255)
3
RGB(0, 255, 255)
4
RGB(0, 255, 0)
5
RGB(255, 0, 255)
6
RGB(255, 0, 0)
7
RGB(255, 255, 0)
8
RGB(255, 255, 255)
9
RGB(0, 0, 128)
10
RGB(0, 128, 128)
11
RGB(0, 128, 0)
12
RGB(128, 0, 128)
13
RGB(128, 0, 0)
14
RGB(128, 128, 0)
15
RGB(128, 128, 128)
16
RGB(192, 192, 192)
pValueINT*out指定されたインデックスに対応する色。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

最初の 16 個のインデックス値は、特殊な下線の色に使用されます。1 から 16 のインデックスが ITextDocument2:SetEffectColor メソッドの呼び出しによって定義されていない場合、GetEffectColor は対応する Microsoft Word の既定の色を返します。

vtbl 48 HRESULT GetImmContext(LONGLONG* pContext)

Text Object Model (TOM) ホストから Input Method Manager (IMM) の入力コンテキストを取得します。

pContextLONGLONG*outIMM の入力コンテキスト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 49 HRESULT GetPreferredFont(INT cp, INT CharRep, INT Options, INT curCharRep, INT curFontSize, LPWSTR* pbstr, INT* pPitchAndFamily, INT* pNewFontSize)

特定の文字レパートリーおよび文字位置に対する優先フォントを取得します。

cpINTin優先フォントの文字位置。
CharRepINTin

優先フォントの文字レパートリーインデックス。次の値のいずれかを指定できます。

tomAboriginal

tomAnsi

tomArabic

tomArmenian

tomBaltic

tomBengali

tomBIG5

tomBraille

tomCherokee

tomCyrillic

tomDefaultCharRep

tomDevanagari

tomEastEurope

tomEmoji

tomEthiopic

tomGB2312

tomGeorgian

tomGreek

tomGujarati

tomGurmukhi

tomHangul

tomHebrew

tomJamo

tomKannada

tomKayahli

tomKharoshthi

tomKhmer

tomLao

tomLimbu

tomMac

tomMalayalam

tomMongolian

tomMyanmar

tomNewTaiLu

tomOEM

tomOgham

tomOriya

tomPC437

tomRunic

tomShiftJIS

tomSinhala

tomSylotinagr

tomSymbol

tomSyriac

tomTaiLe

tomTamil

tomTelugu

tomThaana

tomThai

tomTibetan

tomTurkish

tomUsymbol

tomVietnamese

tomYi

OptionsINTin

優先フォントオプション。下位ワードには次の値の組み合わせを指定できます。

tomIgnoreCurrentFont

tomMatchCharRep

tomMatchFontSignature

tomMatchAscii

tomGetHeightOnly

tomMatchMathFont

Options の上位ワードが tomUseTwips の場合、フォントの高さは twips で指定されます。

curCharRepINTin現在の文字レパートリーのインデックス。
curFontSizeINTin現在のフォントサイズ。
pbstrLPWSTR*outフォントの名前。
pPitchAndFamilyINT*outフォントのピッチとファミリ。
pNewFontSizeINT*out新しいフォントサイズ。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 50 HRESULT GetProperty(INT Type, INT* pValue)

プロパティの値を取得します。

TypeINTin

取得するプロパティの識別子。次のプロパティ ID のいずれかを指定できます。

tomCanCopy

tomCanRedo

tomCanUndo

tomDocMathBuild

tomMathInterSpace

tomMathIntraSpace

tomMathLMargin

tomMathPostSpace

tomMathPreSpace

tomMathRMargin

tomMathWrapIndent

tomMathWrapRight

tomUndoLimit

tomEllipsisMode

tomEllipsisState

pValueINT*outプロパティの値。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 51 HRESULT GetStrings(ITextStrings** ppStrs)

リッチテキスト文字列のコレクションを取得します。

ppStrsITextStrings**outリッチテキスト文字列のコレクション。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

このコレクションは、リッチテキストの操作、特に数式テキストをリニア形式から組み上げ形式へ、またはその逆に変換する際に役立ちます。

vtbl 52 HRESULT Notify(INT Notify)

特定の Input Method Editor (IME) イベントを Text Object Model (TOM) エンジンのクライアントに通知します。

NotifyINTinIME 通知コード。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 53 HRESULT Range2(INT cpActive, INT cpAnchor, ITextRange2** ppRange)

ドキュメントのアクティブなストーリーに対する新しいテキスト範囲を取得します。

cpActiveINTin新しいテキスト範囲のアクティブ端。既定値は 0 で、これはストーリーの先頭を表します。
cpAnchorINTin新しいテキスト範囲のアンカー端。既定値は 0 です。
ppRangeITextRange2**out新しいテキスト範囲。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 54 HRESULT RangeFromPoint2(INT x, INT y, INT Type, ITextRange2** ppRange)

画面上の特定の点にある (または最も近い) 縮退範囲を取得します。

xINTin点の x 座標 (スクリーン座標)。
yINTin点の y 座標 (スクリーン座標)。
TypeINTin指定した点の配置の種類。有効な値の一覧については、ITextRange::GetPoint を参照してください。
ppRangeITextRange2**out

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 55 HRESULT ReleaseCallManager(IUnknown* pVoid)

call manager を解放します。

pVoidIUnknown*inoptional解放する call manager オブジェクト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 56 HRESULT ReleaseImmContext(LONGLONG Context)

Input Method Manager (IMM) の入力コンテキストを解放します。

ContextLONGLONGin解放する IMM の入力コンテキスト。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 57 HRESULT SetEffectColor(INT Index, INT Value)

特殊なテキスト属性に使用する色を指定します。

IndexINTin取得する色のインデックス。値の一覧については、GetEffectColor を参照してください。
ValueINTin指定したインデックスに対する新しい色。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

最初の 16 個のインデックス値は、特殊な下線の色に使用されます。1 から 16 のインデックスが ITextDocument2:SetEffectColor メソッドの呼び出しによって定義されていない場合、対応する Microsoft Word の既定の色が使用されます。

vtbl 58 HRESULT SetProperty(INT Type, INT Value)

プロパティの新しい値を指定します。

TypeINTinプロパティの識別子。指定可能なプロパティ識別子の一覧については、 GetProperty を参照してください。
ValueINTin新しいプロパティ値。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 59 HRESULT SetTypographyOptions(INT Options, INT Mask)

ドキュメントのタイポグラフィオプションを指定します。

OptionsINTin設定するタイポグラフィオプション。指定可能なオプションの一覧については、GetTypographyOptions を参照してください。
MaskINTin設定するオプションを識別するマスク。たとえば、TO_ADVANCEDTYPOGRAPHY をオンにするには、ITextDocument2::SetTypographyOptions (TO_ADVANCEDTYPOGRAPHY, TO_ADVANCEDTYPOGRAPHY) を呼び出します。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 60 HRESULT SysBeep()

システムビープ音を鳴らします。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 61 HRESULT Update(INT Value)

選択範囲とキャレットを更新します。

ValueINTinスクロールフラグ。キャレットが表示されるようにスクロールするには tomTrue を使用します。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 62 HRESULT UpdateWindow()

ビューが変更されたことをクライアントに通知します。Text Object Model (TOM) エンジンがインプレースでアクティブな場合、クライアントはビューを更新する必要があります。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 63 HRESULT GetMathProperties(INT* pOptions)

ドキュメントの数式プロパティを取得します。

pOptionsINT*out

次の数式プロパティの組み合わせ。

プロパティ 説明
tomMathDispAlignMask
ディスプレイモードの配置マスク。
tomMathDispAlignCenter
中央 (既定) 揃え。
tomMathDispAlignLeft
左揃え。
tomMathDispAlignRight
右揃え。
tomMathDispIntUnderOver
ディスプレイモードの積分の範囲 (limits) の位置。
tomMathDispFracTeX
ディスプレイモードの入れ子分数のスクリプトサイズ。
tomMathDispNaryGrow
数式段落の n 項演算子の拡大。
tomMathDocEmptyArgMask
空の引数の表示マスク。
tomMathDocEmptyArgAuto
必要に応じて、空の引数を示すために点線の四角を自動的に使用します。
tomMathDocEmptyArgAlways
空の引数を示すために常に点線の四角を使用します。
tomMathDocEmptyArgNever
空の引数を示しません。
tomMathDocSbSpOpUnchanged
アンダースコア (_) とキャレット (^) をそのまま表示します。
tomMathDocDiffMask
tomMathDocDiffUprighttomMathDocDiffItalictomMathDocDiffOpenItalic オプションのスタイルマスク。
tomMathDocDiffItalic
数式の微分記号に斜体 (既定) を使用します。
tomMathDocDiffUpright
数式の微分記号に直立フォントを使用します。
tomMathDocDiffOpenItalic
数式の微分記号にオープン斜体 (既定) を使用します。
tomMathDispNarySubSup
数式段落の非積分 n 項演算子の範囲 (limits) の位置。
tomMathDispDef
数式段落の間隔の既定値。
tomMathEnableRtl
RTL 段落で右から左 (RTL) の数式ゾーンを有効にします。
tomMathBrkBinMask
数式の行分割マスク。
tomMathBrkBinBefore
二項演算子/関係演算子の前で分割します。
tomMathBrkBinAfter
二項演算子/関係演算子の後で分割します。
tomMathBrkBinDup
二項演算子/関係演算子を前後に複製します。
tomMathBrkBinSubMask
マイナス演算子の複製マスク。
tomMathBrkBinSubMM
- - (両方の行にマイナス)。
tomMathBrkBinSubPM
+ -
tomMathBrkBinSubMP
- +

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 64 HRESULT SetMathProperties(INT Options, INT Mask)

ドキュメントに使用する数式プロパティを指定します。

OptionsINTin設定する数式プロパティ。指定可能なプロパティの一覧については、GetMathProperties を参照してください。
MaskINTin数式マスク。指定可能なマスクの一覧については、GetMathProperties を参照してください。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 65 HRESULT GetActiveStory(ITextStory** ppStory)

アクティブなストーリー、つまりキーボードとマウスの入力を受け取るストーリーを取得します。

ppStoryITextStory**outアクティブなストーリー。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 66 HRESULT SetActiveStory(ITextStory* pStory)

アクティブなストーリー、つまりキーボードとマウスの入力を受け取るストーリーを設定します。

pStoryITextStory*inoptionalアクティブに設定するストーリー。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 67 HRESULT GetMainStory(ITextStory** ppStory)

メインストーリーを取得します。

ppStoryITextStory**outメインストーリー。

戻り値

型: HRESULT

このメソッドが成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

リッチエディットコントロールにはメインストーリーが自動的に含まれます。ITextDocument2::GetNewStory メソッドの呼び出しは不要です。

vtbl 68 HRESULT GetNewStory(ITextStory** ppStory)

新しいストーリーを取得します。

ppStoryITextStory**out新しいストーリー。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 69 HRESULT GetStory(INT Index, ITextStory** ppStory)

特定のインデックスに対応するストーリーを取得します。

IndexINTin取得するストーリーのインデックス。
ppStoryITextStory**outストーリー。

戻り値

型: HRESULT

メソッドが成功した場合は NOERROR を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"

出力引数:
#define global IID_ITextDocument2 "{C241F5E0-7206-11D8-A2C7-00A0D1D6C6B3}"
#usecom global ITextDocument2 IID_ITextDocument2 "{}"
#comfunc global ITextDocument2_GetCaretType          26 var
#comfunc global ITextDocument2_SetCaretType          27 int
#comfunc global ITextDocument2_GetDisplays           28 sptr
#comfunc global ITextDocument2_GetDocumentFont       29 sptr
#comfunc global ITextDocument2_SetDocumentFont       30 sptr
#comfunc global ITextDocument2_GetDocumentPara       31 sptr
#comfunc global ITextDocument2_SetDocumentPara       32 sptr
#comfunc global ITextDocument2_GetEastAsianFlags     33 var
#comfunc global ITextDocument2_GetGenerator          34 var
#comfunc global ITextDocument2_SetIMEInProgress      35 int
#comfunc global ITextDocument2_GetNotificationMode   36 var
#comfunc global ITextDocument2_SetNotificationMode   37 int
#comfunc global ITextDocument2_GetSelection2         38 sptr
#comfunc global ITextDocument2_GetStoryRanges2       39 sptr
#comfunc global ITextDocument2_GetTypographyOptions  40 var
#comfunc global ITextDocument2_GetVersion            41 var
#comfunc global ITextDocument2_GetWindow             42 var
#comfunc global ITextDocument2_AttachMsgFilter       43 sptr
#comfunc global ITextDocument2_CheckTextLimit        44 int,var
#comfunc global ITextDocument2_GetCallManager        45 sptr
#comfunc global ITextDocument2_GetClientRect         46 int,var,var,var,var
#comfunc global ITextDocument2_GetEffectColor        47 int,var
#comfunc global ITextDocument2_GetImmContext         48 var
#comfunc global ITextDocument2_GetPreferredFont      49 int,int,int,int,int,var,var,var
#comfunc global ITextDocument2_GetProperty           50 int,var
#comfunc global ITextDocument2_GetStrings            51 sptr
#comfunc global ITextDocument2_Notify                52 int
#comfunc global ITextDocument2_Range2                53 int,int,sptr
#comfunc global ITextDocument2_RangeFromPoint2       54 int,int,int,sptr
#comfunc global ITextDocument2_ReleaseCallManager    55 sptr
#comfunc global ITextDocument2_ReleaseImmContext     56 int64
#comfunc global ITextDocument2_SetEffectColor        57 int,int
#comfunc global ITextDocument2_SetProperty           58 int,int
#comfunc global ITextDocument2_SetTypographyOptions  59 int,int
#comfunc global ITextDocument2_SysBeep               60
#comfunc global ITextDocument2_Update                61 int
#comfunc global ITextDocument2_UpdateWindow          62
#comfunc global ITextDocument2_GetMathProperties     63 var
#comfunc global ITextDocument2_SetMathProperties     64 int,int
#comfunc global ITextDocument2_GetActiveStory        65 sptr
#comfunc global ITextDocument2_SetActiveStory        66 sptr
#comfunc global ITextDocument2_GetMainStory          67 sptr
#comfunc global ITextDocument2_GetNewStory           68 sptr
#comfunc global ITextDocument2_GetStory              69 int,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。
; ※IDispatch 実装。HSP では comobj 経由でメソッド名による呼び出しも可能(vtbl 不要)。