ControlExtensions.AddProgressBar メソッド (ControlCollection, Range, Single, Single, String)
サイズと位置を指定して、新しい ProgressBar コントロールを文書に追加します。
名前空間: Microsoft.Office.Tools.Word
アセンブリ: Microsoft.Office.Tools.Word.v4.0.Utilities (Microsoft.Office.Tools.Word.v4.0.Utilities.dll 内)
構文
'宣言
<ExtensionAttribute> _
Public Shared Function AddProgressBar ( _
controls As ControlCollection, _
range As Range, _
width As Single, _
height As Single, _
name As String _
) As ProgressBar
public static ProgressBar AddProgressBar(
this ControlCollection controls,
Range range,
float width,
float height,
string name
)
パラメーター
- controls
型 : Microsoft.Office.Tools.Word.ControlCollection
コントロールを追加するコレクション。このパラメーターは手動で指定しないでください。(アプリケーション レベルのプロジェクトの) Document.Controls プロパティまたは (ドキュメント レベルのプロジェクトの) DocumentBase.Controls プロパティによって返されたコレクションでこのメソッドを呼び出す場合、このパラメーターは自動的に指定されます。
- range
型 : Microsoft.Office.Interop.Word.Range
コントロールの位置。
- width
型 : System.Single
コントロールの幅 (ポイント単位)。
- height
型 : System.Single
コントロールの高さ (ポイント単位)。
- name
型 : System.String
ControlCollection インスタンス内のコントロールにインデックスを作成するために使用できる名前。
戻り値
型 : Microsoft.Office.Tools.Word.Controls.ProgressBar
文書に追加されたコントロール。
使用上の注意
Visual Basic および Visual C# では、このメソッドを、ControlCollection 型のオブジェクトのインスタンス メソッドとして呼び出すことができます。インスタンス メソッド構文を使用してこのメソッドを呼び出す場合は、最初のパラメーターを省略します。詳細については、「拡張メソッド (Visual Basic)」または「拡張メソッド (C# プログラミング ガイド)」を参照してください。
例外
| 例外 | 条件 |
|---|---|
| ArgumentNullException | name または range 引数が nullnull 参照 (Visual Basic では Nothing) であるか、または name 引数の長さが 0 である場合。 |
| ControlNameAlreadyExistsException | 同じ名前のコントロールが既に ControlCollection インスタンスに存在する場合。 |
| InvalidRangeException | 指定された範囲が無効である場合。 |
解説
このメソッドを使用すると、ProgressBar オブジェクトを ControlCollection の最後に追加できます。
プログラムで追加された ProgressBar を削除するには、Remove メソッドを使用します。
例
次のコード例は、ProgressBar コントロールを文書の最初の段落に追加し、ProgressBar の現在の位置を 50 に増やします。この例を使用するには、これをドキュメント レベルのプロジェクトの ThisDocument クラスから実行します。
Private Sub WordRangeAddProgressBar()
Me.Paragraphs(1).Range.InsertParagraphBefore()
Dim ProgressBar1 As Microsoft.Office.Tools.Word. _
Controls.ProgressBar = Me.Controls.AddProgressBar( _
Me.Paragraphs(1).Range, 75, 17.25F, "ProgressBar1")
ProgressBar1.Maximum = 100
ProgressBar1.Step = 50
ProgressBar1.PerformStep()
End Sub
private void WordRangeAddProgressBar()
{
this.Paragraphs[1].Range.InsertParagraphBefore();
Microsoft.Office.Tools.Word.Controls.ProgressBar
progressBar1 = this.Controls.AddProgressBar(
this.Paragraphs[1].Range, 75, 17.25F, "progressBar1");
progressBar1.Maximum = 100;
progressBar1.Step = 50;
progressBar1.PerformStep();
}
.NET Framework セキュリティ
- 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。