Pen::SetDashPattern メソッド (gdipluspen.h)

Pen::SetDashPattern メソッドは、この Pen オブジェクトのカスタム ダッシュとスペースの配列を設定します。

構文

Status SetDashPattern(
  [in] const REAL *dashArray,
  [in] INT        count
);

パラメーター

[in] dashArray

型: const REAL*

カスタムダッシュとスペースの長さを指定する実数の配列へのポインター。 配列内のすべての要素は正の実数である必要があります。

[in] count

型: INT

dashArray 配列内の要素の数を指定する整数。 整数は 0 より大きく、配列内の要素の合計数を超えてはなりません。

戻り値

種類: 状態

メソッドが成功した場合は、Status 列挙体の要素である Ok を返します。

メソッドが失敗した場合は、 Status 列挙体の他の要素のいずれかを返します。

解説

このメソッドは、この Pen オブジェクトの DashStyle 列挙体を DashStyleCustom に設定します。

dashArray 配列の要素は、ダッシュ パターン内の各ダッシュとスペースの長さを設定します。 最初の要素はダッシュの長さを設定し、2 番目の要素はスペースの長さを設定し、3 番目の要素はダッシュの長さを設定します。

ダッシュ パターンの各ダッシュとスペースの長さは、配列内の要素値と Pen オブジェクトの幅の積です。

例

次の例では、実数の配列を作成します。 次に、 Pen オブジェクトを作成し、配列に基づいてダッシュ パターンを設定し、カスタム破線を描画します。

VOID Example_SetDashPattern(HDC hdc)
{
   Graphics graphics(hdc);

   // Create and set an array of real numbers.
   REAL dashVals[4] = {
      5.0f,   // dash length 5
      2.0f,   // space length 2
      15.0f,  // dash length 15
      4.0f};  // space length 4

   // Create a Pen object.
   Pen pen(Color(255, 0, 0, 0), 5);

   // Set the dash pattern for the custom dashed line.
   pen.SetDashPattern(dashVals, 4);

   // Draw the custom dashed line.
   graphics.DrawLine(&pen, 5, 20, 405, 200); 
}

要件

サポートされている最小のクライアント	Windows XP、Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	gdipluspen.h (Gdiplus.h を含む)
Library	Gdiplus.lib
[DLL]	Gdiplus.dll

関連項目

ユーザー設定の破線の描画

ペン

Pen::GetDashPattern

Pen::GetDashPatternCount

ペン、直線、および四角形