Office.CoercionType enum

パッケージ:

office

呼び出されたメソッドによって返される、または設定されるデータを強制的に変換する方法を指定します。

注釈

それぞれの CoercionType アプリケーションとプラットフォームのサポートは、次の要件セットの説明で指定します。

• HtmlCoercion、 (使用時 Office.CoercionType.Html)

• ImageCoercion 1.1 (使用時 Office.CoercionType.Image)

• MatrixCoercion (使用時 Office.CoercionType.Matrix)

• OoxmlCoercion (使用時 Office.CoercionType.Ooxml)

• Selection

• TableCoercion (使用時 Office.CoercionType.Table)

• TextCoercion (使用時 Office.CoercionType.Text)

• ImageCoercion 1.2 (使用時 Office.CoercionType.XmlSvg)

例

// This function displays the currently selected text in the console.
// It uses the Common APIs.
function run() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Text, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error(asyncResult.error.message);
        } else {
            console.log(`The selected data is "${asyncResult.value}".`);
        }
    });
}

フィールド

Html	データを HTML として取得または設定します。 注: Wordアドインのデータと Outlook 用 Outlook アドイン (作成モード) にのみ適用されます。
Image	データは返されるか、イメージ ストリームとして設定されます。 注: Excel、Word、PowerPoint のデータにのみ適用されます。
Matrix	データをヘッダーなしの表形式データとして取得または設定します。 データは、1 次元の一連の文字を含む配列の配列として取得または設定されます。 たとえば、2 つの列の文字列値の 3 行は、[["R1C1"、"R1C2"]、["R2C1"、"R2C2"]、["R3C1"、"R3C2"] です。 注: Excel とWordのデータにのみ適用されます。
Ooxml	データを Office Open XML として取得または設定します。 注: Word内のデータにのみ適用されます。
SlideRange	選択したスライドの ID、タイトル、インデックスの配列を含む JSON オブジェクトを返します。 たとえば、 {"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]} 2 つのスライドを選択した場合などです。 注: Document.getSelectedData メソッドを呼び出して現在のスライドまたは選択したスライド範囲を取得する場合にのみ、PowerPoint のデータに適用されます。
Table	データをヘッダー付き (省略可能) の表形式データとして取得または設定します。 データをヘッダー付き (省略可能) の表形式データとして取得または設定します。 注: Excel とWordのデータにのみ適用されます。
Text	データをテキスト (文字列) として返すか設定します。 データは、1 次元の一連の文字として取得または設定されます。
XmlSvg	データは、SVG イメージを含む XML データとして返されるか、設定されます。 注: Excel、Word、PowerPoint のデータにのみ適用されます。