Excel.TimelineStyle class

パッケージ:

excel

タイムライン内の領域別にスタイル要素を定義するTimelineStyleを表します。

Extends

OfficeExtension.ClientObject

注釈

API セット: ExcelApi 1.10

使用元

• Excel.TimelineStyleCollection: add, getDefault, getItem, getItemOrNullObject, items, setDefault

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
name	タイムライン スタイルの名前を指定します。
readOnly	この TimelineStyle オブジェクトが読み取り専用かどうかを指定します。

メソッド

delete()	表スタイルを削除します。
duplicate()	すべてのスタイル要素のコピーを使用して、このタイムライン スタイルの複製を作成します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TimelineStyle オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TimelineStyleData と型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

name

タイムライン スタイルの名前を指定します。

name: string;

プロパティ値

string

注釈

API セット: ExcelApi 1.10

readOnly

この TimelineStyle オブジェクトが読み取り専用かどうかを指定します。

readonly readOnly: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.10

メソッドの詳細

delete()

表スタイルを削除します。

delete(): void;

返品

void

注釈

API セット: ExcelApi 1.10

duplicate()

すべてのスタイル要素のコピーを使用して、このタイムライン スタイルの複製を作成します。

duplicate(): Excel.TimelineStyle;

返品

Excel.TimelineStyle

この タイムライン スタイルから複製された新しい TimelineStyle オブジェクト。

注釈

API セット: ExcelApi 1.10

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.TimelineStyleLoadOptions): Excel.TimelineStyle;

パラメーター

options

Excel.Interfaces.TimelineStyleLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Excel.TimelineStyle

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.TimelineStyle;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Excel.TimelineStyle

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TimelineStyle;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Excel.TimelineStyle

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.TimelineStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties

Excel.Interfaces.TimelineStyleUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options

OfficeExtension.UpdateOptions

プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

返品

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.TimelineStyle): void;

パラメーター

properties

Excel.TimelineStyle

返品

void

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.TimelineStyle オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.TimelineStyleData と型指定) を返します。

toJSON(): Excel.Interfaces.TimelineStyleData;

返品

Excel.Interfaces.TimelineStyleData