Class Property
コンポーネント（通常はビデオ キャプチャ デバイス）のプロパティを表します。
継承
実装
継承されたメンバ
Namespace: ic4
Assembly: ic4dotnet.dll
構文
public class Property : HandleObject, IDisposable解説
すべてのプロパティ型は Property から派生しています。例として PropInteger、PropCommand、PropEnumeration があります。
PropEnumEntry もカテゴリツリーの一部ではありませんが Property から派生しています。それでも、列挙エントリはすべての標準的なプロパティ操作をサポートします。
Property オブジェクトおよび Property から派生したクラスのオブジェクトは、次の複数の方法で生成されます。
- 既知のプロパティ名を Find(string) または FindInteger(string) などの型指定された関連関数に渡す方法
- プロパティ識別子を Find(PropIdEnumeration) またはそのオーバーロードに渡す方法
- Features を列挙して、カテゴリ内のすべてのプロパティを取得する方法
- All を列挙して、プロパティマップのカテゴリツリー内にあるすべてのプロパティを取得する方法
- Entries を列挙して、列挙型プロパティのすべてのエントリを取得する方法
- SelectedProperties を列挙して、プロパティによって選択されているプロパティを取得する方法
Property オブジェクトは内部ライブラリオブジェクトへの参照を保持しています。参照を解放するには Dispose() を呼び出してください。
デバイスがクローズされた後、Property オブジェクトは無効となり、その後に使用すると例外がスローされます。
プロパティ
Description
プロパティの説明を表します。
宣言
public string Description { get; }例外
| 型 | 条件 |
|---|---|
| IC4Exception | 詳細については ErrorCode および ToString() を確認してください。 |
DisplayName
プロパティの表示名を表します。
宣言
public string DisplayName { get; }プロパティ値
| 型 | 説明 |
|---|---|
| string | プロパティの表示名。 |
備考
プロパティの表示名は、ユーザーインターフェースに表示することを目的としたプロパティの文字列表現です。例えば、ExposureTime プロパティの表示名は通常 Exposure Time になります。
IsAvailable
プロパティが現在使用可能かどうかを示します。
宣言
public bool IsAvailable { get; }プロパティ値
| 型 | 説明 |
|---|---|
| bool | true: プロパティが現在使用可能な場合。false: 使用できない場合。 |
備考
プロパティが使用できない場合、その値の読み取りや書き込みは失敗します。
プロパティの値がデバイスの現在の状態では意味を持たない場合、そのプロパティは使用不可になることがあります。
また、別のプロパティへの書き込みによって、プロパティの使用可否状態が変化することがあります。
IsLikelyLockedByStream
データストリームがアクティブなためにプロパティがロックされている可能性があるかどうかを判定しようとします。
宣言
public bool IsLikelyLockedByStream { get; }プロパティ値
| 型 | 説明 |
|---|---|
| bool | true: プロパティが現在ロックされており、データストリームを停止するとロック解除される可能性が高い場合。false: プロパティが現在ロックされていない、またはデータストリームを停止してもロック解除される可能性が低い場合。 |
備考
技術的な理由により、この関数は将来の状態を常に正確に予測できるわけではありません。
IsLocked
プロパティが現在ロックされているかどうかを示します。
宣言
public bool IsLocked { get; }プロパティ値
| 型 | 説明 |
|---|---|
| bool | true: プロパティが現在ロックされている場合。false: ロックされていない場合。 |
備考
ロックされているプロパティは読み取り可能ですが、値の書き込みは失敗します。
プロパティのロック状態は、別のプロパティへの書き込みによって変化することがあります。
ロックされることのある一般的なプロパティの例として、ExposureTime や Gain があり、これは ExposureAuto や GainAuto が有効な場合です。
IsReadonly
プロパティが読み取り専用かどうかを示します。
宣言
public bool IsReadonly { get; }プロパティ値
| 型 | 説明 |
|---|---|
| bool | true: プロパティが読み取り専用の場合。false: 読み取り専用ではない場合。 |
備考
読み取り専用のプロパティは、決して書き込み可能になることはなく、読み取り専用状態は変化しません。
読み取り専用プロパティの一般的な例として、DeviceTemperature があります。
IsSelector
このプロパティの値が、他のプロパティの意味や値に影響を与えるかどうかを示します。
宣言
public bool IsSelector { get; }プロパティ値
| 型 | 説明 |
|---|---|
| bool | true: プロパティがセレクタの場合。false: セレクタでない場合。 |
Name
プロパティの名前を表します。
宣言
public string Name { get; }プロパティ値
| 型 | 説明 |
|---|---|
| string | プロパティの名前。 |
例外
| 型 | 条件 |
|---|---|
| IC4Exception | 詳細については ErrorCode および ToString() を確認してください。 |
SelectedProperties
Enumerates the properties whose values' meaning depend on this property.
宣言
public IEnumerable<Property> SelectedProperties { get; }プロパティ値
| 型 | 説明 |
|---|---|
| IEnumerable<Property> | An enumeration of Property objects representing the property's selected properties. |
例外
| 型 | 条件 |
|---|---|
| IC4Exception | 詳細については ErrorCode および ToString() を確認してください。 |
Tooltip
プロパティのツールチップを表します。
宣言
public string Tooltip { get; }プロパティ値
| 型 | 説明 |
|---|---|
| string | プロパティのツールチップ。 |
備考
プロパティのツールチップは、ユーザーインターフェースでツールチップが必要な場合に使用できるテキストです。通常、プロパティの非常に短い説明が表示されます。
例外
| 型 | 条件 |
|---|---|
| IC4Exception | 詳細については ErrorCode および ToString() を確認してください。 |
Visibility
プロパティの可視性のヒントを表します。
宣言
public PropertyVisibility Visibility { get; }プロパティ値
| 型 | 説明 |
|---|---|
| PropertyVisibility | プロパティの可視性ヒント。 |
備考
可視性のヒントは、異なる複雑さのユーザーインターフェースを作成する際に使用できます。
最も一般的に使用されるプロパティは「初心者」可視性が適用され、使用頻度の低い機能や診断用機能は「上級者」や「非表示」とタグ付けされる場合があります。
イベント
Notification
プロパティの値やロック状態など、何らかの側面が変更されるたびに発生します。
宣言
public event EventHandler Notificationイベントの型
| 型 | 説明 |
|---|---|
| EventHandler |
