次の方法で共有

PowerPoint.ShapeLineFormat class

  • リファレンス
パッケージ:
powerpoint

図形オブジェクトの線の書式を表します。 画像と幾何学的図形の場合、線の書式設定は図形の境界線を表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: PowerPointApi 1.4 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

プロパティ

color

#RRGGBB 形式 ("FFA500" など) または名前付き HTML の色 (例: "オレンジ") の形式で、行の色を HTML 色形式で表します。
context

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

線のダッシュ スタイルを表します。 線が非表示の場合、または破線のスタイルが一定ではない場合は、null を返します。 詳細については、「PowerPoint.ShapeLineDashStyle」を参照してください。
style

図形の線スタイルを表します。 線が非表示の場合、またはスタイルが一定ではない場合は、null を返します。 詳細については、「PowerPoint.ShapeLineStyle」を参照してください。
transparency

線の透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値として指定します。 図形の透明度が一定ではない場合は、null を返します。
visible

図形要素の線の書式を表示するかどうかを指定します。 図形に一貫性のない可視性がある場合に null を返します。
weight

線の太さ (ポイント数) を表します。 線が表示されない場合、または線の太さが一致しない場合に null を返します。

メソッド

load(options)

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

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

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

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

プロパティの詳細

color

#RRGGBB 形式 ("FFA500" など) または名前付き HTML の色 (例: "オレンジ") の形式で、行の色を HTML 色形式で表します。

color: string;

プロパティ値

string

注釈

[ API セット: PowerPointApi 1.4 ]

context

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

context: RequestContext;

プロパティ値

PowerPoint.RequestContext

dashStyle

線のダッシュ スタイルを表します。 線が非表示の場合、または破線のスタイルが一定ではない場合は、null を返します。 詳細については、「PowerPoint.ShapeLineDashStyle」を参照してください。

dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

プロパティ値

PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"

注釈

[ API セット: PowerPointApi 1.4 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml

// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
  // Get the type of shape for every shape in the collection.
  const shapes = context.presentation.slides.getItemAt(0).shapes;
  shapes.load("type");
  await context.sync();

  // Change the dash style for shapes of the type `line`.
  shapes.items.forEach((shape) => {
    if (shape.type === PowerPoint.ShapeType.line) {
      shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

style

図形の線スタイルを表します。 線が非表示の場合、またはスタイルが一定ではない場合は、null を返します。 詳細については、「PowerPoint.ShapeLineStyle」を参照してください。

style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

プロパティ値

PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"

注釈

[ API セット: PowerPointApi 1.4 ]

transparency

線の透明度の割合を、0.0 (不透明) から 1.0 (クリア) までの値として指定します。 図形の透明度が一定ではない場合は、null を返します。

transparency: number;

プロパティ値

number

注釈

[ API セット: PowerPointApi 1.4 ]

visible

図形要素の線の書式を表示するかどうかを指定します。 図形に一貫性のない可視性がある場合に null を返します。

visible: boolean;

プロパティ値

boolean

注釈

[ API セット: PowerPointApi 1.4 ]

weight

線の太さ (ポイント数) を表します。 線が表示されない場合、または線の太さが一致しない場合に null を返します。

weight: number;

プロパティ値

number

注釈

[ API セット: PowerPointApi 1.4 ]

メソッドの詳細

load(options)

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

load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;

パラメーター

options
PowerPoint.Interfaces.ShapeLineFormatLoadOptions

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

戻り値

PowerPoint.ShapeLineFormat

load(propertyNames)

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

load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;

パラメーター

propertyNames

string | string[]

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

戻り値

PowerPoint.ShapeLineFormat

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeLineFormat;

パラメーター

propertyNamesAndPaths

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

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

戻り値

PowerPoint.ShapeLineFormat

toJSON()

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

toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;

戻り値

PowerPoint.Interfaces.ShapeLineFormatData