Excel.ShapeFill class

Shape オブジェクトの塗りつぶしの書式設定を表します。Represents the fill formatting of a shape object.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

foregroundColor

フォーム#の RRGGBB ("FFA500" など) または名前付きの html 色 (例: "オレンジ") の、html 色形式での図形の塗りつぶしの前景色の色を表します。Represents the shape fill foreground color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

transparency

塗りつぶしの透明度の割合を示す 0.0 (不透明) から 1.0 (透明) までの値を取得または設定します。Returns or sets the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). 図形の種類が透明度をサポートしていない場合、または図形の塗りつぶしが一定ではない場合 (グラデーション塗りつぶしの種類など) は、null を返します。Returns null if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

type

図形の塗りつぶしの種類を返します。Returns the fill type of the shape. 読み取り専用です。Read-only. 詳細については、Excel.ShapeFillType をご覧ください。See Excel.ShapeFillType for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

メソッド

clear()

この図形の塗りつぶしの書式設定をクリアします。Clears the fill formatting of this shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

setSolidColor(color)

図形の塗りつぶしの書式設定を均一な色に設定します。Sets the fill formatting of the shape to a uniform color. これにより、塗りつぶしの種類が "Solid" に変更されます。This changes the fill type to "Solid".

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の塗りつぶしオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ShapeFillData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeFill object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeFillData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

foregroundColor

フォーム#の RRGGBB ("FFA500" など) または名前付きの html 色 (例: "オレンジ") の、html 色形式での図形の塗りつぶしの前景色の色を表します。Represents the shape fill foreground color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange")

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

foregroundColor: string;

プロパティ値

string

transparency

塗りつぶしの透明度の割合を示す 0.0 (不透明) から 1.0 (透明) までの値を取得または設定します。Returns or sets the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). 図形の種類が透明度をサポートしていない場合、または図形の塗りつぶしが一定ではない場合 (グラデーション塗りつぶしの種類など) は、null を返します。Returns null if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

transparency: number;

プロパティ値

number

type

図形の塗りつぶしの種類を返します。Returns the fill type of the shape. 読み取り専用です。Read-only. 詳細については、Excel.ShapeFillType をご覧ください。See Excel.ShapeFillType for details.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";

プロパティ値

Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"

メソッドの詳細

clear()

この図形の塗りつぶしの書式設定をクリアします。Clears the fill formatting of this shape.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

clear(): void;

戻り値

void

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.ShapeFill-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.ShapeFill - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ShapeFill-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.ShapeFill - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeFill-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ShapeFill - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.ShapeFillUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.ShapeFill): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ShapeFill): void;

パラメーター

properties
Excel.ShapeFill

戻り値

void

setSolidColor(color)

図形の塗りつぶしの書式設定を均一な色に設定します。Sets the fill formatting of the shape to a uniform color. これにより、塗りつぶしの種類が "Solid" に変更されます。This changes the fill type to "Solid".

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

setSolidColor(color: string): void;

パラメーター

color
string

#RRGGBB の形式 ("FFA500" など) または名前付きの html 色 (例: "オレンジ") の、html 色形式の塗りつぶし色を表す文字列。A string that represents the fill color in HTML color format, of the form #RRGGBB (e.g. "FFA500") or as a named HTML color (e.g. "orange").

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel の塗りつぶしオブジェクトは API オブジェクトであるのにtoJSON対し、メソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ShapeFillData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeFill object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeFillData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ShapeFillData;

戻り値