Excel.HeaderFooterPicture class
ワークシートのヘッダーまたはフッターの画像を表します。
- Extends
注釈
使用元
プロパティ
| brightness | 画像の明るさを指定します。 このプロパティの値は、0.0 (最も暗い) から 1.0 (最も明るい) までの数値で指定する必要があります。 |
| color |
画像の色変換の種類を指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| contrast | 画像のコントラストを指定します。 このプロパティの値は、0.0 (最小コントラスト) から 1.0 (最も強いコントラスト) までの数値にする必要があります。 |
| crop |
画像の下部から切り取られるポイントの数を指定します。 |
| crop |
画像の左側から切り取られるポイントの数を指定します。 |
| crop |
画像の右側から切り取られるポイントの数を指定します。 |
| crop |
画像の上部から切り取られる点の数を指定します。 |
| filename | ソース オブジェクトが保存される場所への URL (イントラネットまたは Web) またはパス (ローカルまたはネットワーク) を指定します。 |
| height | 画像の高さをポイント単位で指定します。 |
| lock |
サイズを変更したときに、図が元の縦横比を維持するかどうかを示す値を指定します。
|
| width | 画像の幅をポイント単位で指定します。 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
brightness
画像の明るさを指定します。 このプロパティの値は、0.0 (最も暗い) から 1.0 (最も明るい) までの数値で指定する必要があります。
brightness: number;プロパティ値
number
注釈
colorType
画像の色変換の種類を指定します。
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";プロパティ値
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
contrast
画像のコントラストを指定します。 このプロパティの値は、0.0 (最小コントラスト) から 1.0 (最も強いコントラスト) までの数値にする必要があります。
contrast: number;プロパティ値
number
注釈
cropBottom
cropLeft
cropRight
cropTop
filename
ソース オブジェクトが保存される場所への URL (イントラネットまたは Web) またはパス (ローカルまたはネットワーク) を指定します。
filename: string;プロパティ値
string
注釈
height
lockAspectRatio
サイズを変更したときに、図が元の縦横比を維持するかどうかを示す値を指定します。
true それがそのプロポーションを保持する場合。それ以外の場合は、 false。
lockAspectRatio: boolean;プロパティ値
boolean
注釈
width
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.HeaderFooterPicture;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.HeaderFooterPicture;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.HeaderFooterPicture): void;パラメーター
- properties
- Excel.HeaderFooterPicture
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.HeaderFooterPicture オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.HeaderFooterPictureData と型指定) を返します。
toJSON(): Excel.Interfaces.HeaderFooterPictureData;