CodeGeneratorOptions

.NET Framework クラス ライブラリ リファレンス

CodeGenerator.Options プロパティ

コード ジェネレータで使用されるオプションを取得します。

名前空間: System.CodeDom.Compiler
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Protected ReadOnly Property
 Options As CodeGeneratorOptions

Visual Basic (使用法)

Dim value As CodeGeneratorOptions

value = Me.Options

C#

protected CodeGeneratorOptions Options { get;
 }

C++

protected:
property CodeGeneratorOptions^ Options {
    CodeGeneratorOptions^ get ();
}

J#

/** @property */
protected CodeGeneratorOptions get_Options ()

JScript

protected function get Options
 () : CodeGeneratorOptions

プロパティ値
コード ジェネレータで使用されるオプションを示す CodeGeneratorOptions オブジェクト。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
CodeGenerator クラス
CodeGenerator メンバ
System.CodeDom.Compiler 名前空間

CodeGeneratorOptions クラス

コード ジェネレータで使用するオプションのセットを表します。

名前空間: System.CodeDom.Compiler
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Class CodeGeneratorOptions

Visual Basic (使用法)

Dim instance As CodeGeneratorOptions

C#

public class CodeGeneratorOptions

C++

public ref class CodeGeneratorOptions

J#

public class CodeGeneratorOptions

JScript

public class CodeGeneratorOptions

解説

CodeGeneratorOptions は、コード生成中に使用するオプションを指定するために、ICodeGenerator 実装のコード生成メソッドに渡されます。

IndentString プロパティは、各インデント幅に使用する文字列を指定します。BracingStyle プロパティは、コード ブロックの境界を示す中かっこの配置スタイルを指定します。ElseOnClosing プロパティは、if ブロックや try ブロックの終了行に、else、catch、finally の各ブロックを中かっこも含めて追加するかどうかを指定します。BlankLinesBetweenMembers プロパティは、各メンバの間に空行を挿入するかどうかを指定します。

ICodeGenerator 実装は、Item ディクショナリ インデクサを使用して、データを設定したり渡すことができるカスタム コード生成オプションを提供できます。コード ジェネレータは、このディクショナリを検索して、追加のコード生成オプションを見つけることができます。

メモ
このクラスは、すべてのメンバに適用されるリンク確認要求および継承確認要求をクラス レベルで格納します。直前の呼び出し元または派生クラスに完全信頼のアクセス許可がない場合、SecurityException がスローされます。セキュリティ要求の詳細については、「リンク確認要求」および「継承確認要求」を参照してください。

使用例

Visual Basic

' Creates a new CodeGeneratorOptions.
Dim genOptions As New CodeGeneratorOptions()

' Sets a value indicating that the code generator should insert blank
 lines between type members.
genOptions.BlankLinesBetweenMembers = True

' Sets the style of bracing format to use: either "Block"
 to start a
' bracing block on the same line as the declaration of its container,
 or 
' "C" to start the bracing for the block on the following
 line.
genOptions.BracingStyle = "C"

' Sets a value indicating that the code generator should not append
 an else, 
' catch or finally block, including brackets, at the closing line of
 a preceeding if or try block.
genOptions.ElseOnClosing = False

' Sets the string to indent each line with.
genOptions.IndentString = "    "

' Uses the CodeGeneratorOptions indexer property to set an
' example object to the type's string-keyed ListDictionary.
' Custom ICodeGenerator implementations can use objects 
' in this dictionary to customize process behavior.
genOptions("CustomGeneratorOptionStringExampleID")
 = "BuildFlags: /A /B /C /D /E"

C#

// Creates a new CodeGeneratorOptions.
CodeGeneratorOptions genOptions = new CodeGeneratorOptions();

// Sets a value indicating that the code generator should insert blank
 lines between type members.
genOptions.BlankLinesBetweenMembers = true;

// Sets the style of bracing format to use: either "Block"
 to start a
// bracing block on the same line as the declaration of its container,
 or 
// "C" to start the bracing for the block on the following
 line.
genOptions.BracingStyle = "C";

// Sets a value indicating that the code generator should not append
 an else, 
// catch or finally block, including brackets, at the closing line of
 a preceeding if or try block.
genOptions.ElseOnClosing = false;

// Sets the string to indent each line with.
genOptions.IndentString = "    ";

// Uses the CodeGeneratorOptions indexer property to set an
// example object to the type's string-keyed ListDictionary.
// Custom ICodeGenerator implementations can use objects 
// in this dictionary to customize process behavior.
genOptions["CustomGeneratorOptionStringExampleID"] = "BuildFlags:
 /A /B /C /D /E";            

C++

// Creates a new CodeGeneratorOptions.
CodeGeneratorOptions^ genOptions = gcnew CodeGeneratorOptions;

// Sets a value indicating that the code generator should insert blank
 lines between type members.
genOptions->BlankLinesBetweenMembers = true;

// Sets the style of bracing format to use: either S"Block"
 to start a
// bracing block on the same line as the declaration of its container,
 or
// S"C" to start the bracing for the block on the following
 line.
genOptions->BracingStyle = "C";

// Sets a value indicating that the code generator should not append
 an else,
// catch or finally block, including brackets, at the closing line of
 a preceeding if or try block.
genOptions->ElseOnClosing = false;

// Sets the String* to indent each line with.
genOptions->IndentString = "    ";

// Uses the CodeGeneratorOptions indexer property to set an
// example Object* to the type's String*-keyed ListDictionary.
// Custom ICodeGenerator* implementations can use objects
// in this dictionary to customize process behavior.
genOptions[ "CustomGeneratorOptionStringExampleID" ] = "BuildFlags:
 /A /B /C /D /E";

.NET Framework のセキュリティ

• SecurityPermission  (CodeGeneratorOptions のメンバを呼び出すためのアクセス許可)。要求値 : LinkDemand、名前付きアクセス許可セット、FullTrust。
• SecurityPermission  (CodeGeneratorOptions クラスから派生させるために必要なアクセス許可)。要求値 : InheritanceDemand、名前付きアクセス許可セット、FullTrust。

継承階層

System.Object
  System.CodeDom.Compiler.CodeGeneratorOptions

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
CodeGeneratorOptions メンバ
System.CodeDom.Compiler 名前空間

CodeGeneratorOptions コンストラクタ

CodeGeneratorOptions クラスの新しいインスタンスを初期化します。

名前空間: System.CodeDom.Compiler
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New CodeGeneratorOptions

C#

public CodeGeneratorOptions ()

C++

public:
CodeGeneratorOptions ()

J#

public CodeGeneratorOptions ()

JScript

public function CodeGeneratorOptions ()

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
CodeGeneratorOptions クラス
CodeGeneratorOptions メンバ
System.CodeDom.Compiler 名前空間

CodeGeneratorOptions プロパティ

パブリック プロパティ

	名前	説明
	BlankLinesBetweenMembers	各メンバの間に空行を挿入するかどうかを示す値を取得または設定します。
	BracingStyle	中かっこの記述時に適用するスタイルを取得または設定します。
	ElseOnClosing	else、catch、finally の各ブロックを中かっこも含め、先行する if ブロックまたは try ブロックの終了行に追加するかどうかを示す値を取得または設定します。
	IndentString	インデントに使用する文字列を取得または設定します。
	Item	指定したインデックスにあるオブジェクトを取得または設定します。
	VerbatimOrder	メンバがメンバ コレクションに現れる順番でメンバを生成するかどうかを示す値を取得または設定します。

参照

関連項目

CodeGeneratorOptions クラス
System.CodeDom.Compiler 名前空間

CodeGeneratorOptions メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

CodeGeneratorOptions クラス
System.CodeDom.Compiler 名前空間

CodeGeneratorOptions メンバ

コード ジェネレータで使用するオプションのセットを表します。

CodeGeneratorOptions データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	CodeGeneratorOptions	CodeGeneratorOptions クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	BlankLinesBetweenMembers	各メンバの間に空行を挿入するかどうかを示す値を取得または設定します。
	BracingStyle	中かっこの記述時に適用するスタイルを取得または設定します。
	ElseOnClosing	else、catch、finally の各ブロックを中かっこも含め、先行する if ブロックまたは try ブロックの終了行に追加するかどうかを示す値を取得または設定します。
	IndentString	インデントに使用する文字列を取得または設定します。
	Item	指定したインデックスにあるオブジェクトを取得または設定します。
	VerbatimOrder	メンバがメンバ コレクションに現れる順番でメンバを生成するかどうかを示す値を取得または設定します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

CodeGeneratorOptions クラス
System.CodeDom.Compiler 名前空間