Class PropEnumeration

列挙型プロパティは、名前付きエントリの一覧から値を選択する機能を表します。

継承

object
HandleObject
Property
PropEnumeration

実装

継承されたメンバ

Namespace: ic4
Assembly: ic4dotnet.dll

構文

public class PropEnumeration : Property, IDisposable

解説

列挙型プロパティの一般的な例としては、PixelFormat、TriggerMode、ExposureAuto などがあります。
列挙型プロパティの値は、列挙エントリの名前または値のいずれによっても取得および設定できます。
列挙エントリは PropEnumEntry オブジェクトとして表され、使用可能なエントリは Entries によって取得されます。
PropEnumeration インスタンスは、次の複数の方法で生成されます。

プロパティ

Entries

列挙型のエントリ一覧を列挙します。

宣言

public IEnumerable<PropEnumEntry> Entries { get; }

プロパティ値

型 説明
IEnumerable<PropEnumEntry> 列挙型の各エントリを表す PropEnumEntry オブジェクトの列挙。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

IntValue

この列挙型プロパティで現在選択されているエントリの整数値を表します。

宣言

public long IntValue { get; set; }

プロパティ値

型 説明
long この列挙型プロパティで現在選択されているエントリの整数値。

SelectedEntry

この列挙型プロパティで現在選択されているエントリを表します。

宣言

public PropEnumEntry SelectedEntry { get; set; }

プロパティ値

型 説明
PropEnumEntry この列挙型プロパティで現在選択されているエントリ。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

Value

この列挙型プロパティで現在選択されているエントリの名前を表します。

宣言

public string Value { get; set; }

プロパティ値

型 説明
string この列挙型プロパティで現在選択されているエントリの名前。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

メソッド

FindEntry(long)

指定した値を持つ列挙エントリを検索します。

宣言

public PropEnumEntry FindEntry(long value)

パラメータ

型 名前 説明
long value 検索する列挙エントリの値。

戻り値

型 説明
PropEnumEntry 指定した値を持つ PropEnumEntry。

例外

型 条件
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

FindEntry(string)

指定した名前を持つ列挙エントリを検索します。

宣言

public PropEnumEntry FindEntry(string name)

パラメータ

型 名前 説明
string name 検索する列挙エントリの名前。

戻り値

型 説明
PropEnumEntry 指定した名前を持つ PropEnumEntry。

例外

型 条件
ArgumentNullException

name is null
IC4Exception 詳細については ErrorCode および ToString() を確認してください。

実装

IDisposable