Class PropInteger

整数型プロパティは、値が整数である機能を表します。

継承

object
HandleObject
Property
PropInteger

実装

継承されたメンバ

Namespace: ic4
Assembly: ic4dotnet.dll

構文

public class PropInteger : Property, IDisposable

解説

整数型プロパティの一般的な例としては、Width や Height があります。
整数型プロパティでは、有効な値の範囲を制限できます。設定可能な値の範囲は、Minimum および Maximum を読み取ることで取得できます。
さらに、インクリメント値や有効値セットによって、設定可能な値を制限することもできます。詳細については、IncrementMode、Increment、ValidValueSet を参照してください。

整数型プロパティは、ユーザーインターフェースを作成する際に有用なヒントも提供します。

PropInteger インスタンスは、複数の方法で生成されます。

プロパティ

Increment

この整数型プロパティで受け付けられる有効値のステップサイズ

宣言

public long Increment { get; }

プロパティ値

型 説明
long この整数型プロパティで受け付けられる有効値のステップサイズ
備考

Increment は、整数型プロパティで設定可能な有効値の集合を制限します。
たとえば、プロパティの最小値が 0、最大値が 10、Increment が 2 の場合、1 はこのプロパティの有効な値ではありません。
IncrementMode が Increment と等しくない場合、Increment にアクセスすると例外がスローされます。

例外

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

IncrementMode

この float 型プロパティが、最小値から最大値の間でどのように有効な値を制限するかを示します。

宣言

public PropertyIncrementMode IncrementMode { get; }

プロパティ値

型 説明
PropertyIncrementMode プロパティのインクリメントモード
備考

整数型プロパティには、2 種類のインクリメントモードがあります。

インクリメントモード 説明
Increment Increment の倍数のみ設定できます。
ValueSet ValidValueSet に含まれる値のみ設定できます。

Maximum

このプロパティで受け付けられる最大値。

宣言

public long Maximum { get; }

プロパティ値

型 説明
long このプロパティで受け付けられる最大値。

例外

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

Minimum

このプロパティで受け付けられる最小値。

宣言

public long Minimum { get; }

プロパティ値

型 説明
long このプロパティで受け付けられる最小値。

例外

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

Representation

この整数型プロパティに推奨される表現形式

宣言

public IntRepresentation Representation { get; }

プロパティ値

型 説明
IntRepresentation この整数型プロパティに推奨される表現形式
備考

この表現形式は、ユーザーインターフェース作成時のヒントとして使用できます。

Unit

この整数型プロパティの単位。

宣言

public string Unit { get; }

プロパティ値

型 説明
string この整数型プロパティの単位。

例外

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

ValidValueSet

このプロパティで有効な値の集合。

宣言

public IReadOnlyList<long> ValidValueSet { get; }

プロパティ値

型 説明
IReadOnlyList<long> このプロパティで有効な値を含むリスト
備考

IncrementMode が ValueSet と等しくない場合、Increment にアクセスすると例外がスローされます。

例外

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

Value

このプロパティの現在の値
値は、プロパティの書き込み権限が制限されていない場合のみ設定可能です。
詳細は IsLocked、IsReadonly、IsAvailable を参照してください。

宣言

public long Value { get; set; }

プロパティ値

型 説明
long このプロパティの現在の値
備考

値にアクセスして例外を避けたい場合は、TryGetValue(out long) または TrySetValue(long) を使用してください。

例外

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

メソッド

TryGetValue(out long)

プロパティの現在の値を取得しようとします。

宣言

public bool TryGetValue(out long val)

パラメータ

型 名前 説明
long val 成功時にプロパティの現在の値を受け取る出力パラメータ

戻り値

型 説明
bool 操作が成功した場合は true、それ以外の場合は false
備考

Value プロパティを直接読み取る場合とは異なり、このメソッドはエラー発生時に例外をスローしません。

TrySetValue(long)

プロパティの現在の値を設定しようとします。

宣言

public bool TrySetValue(long val)

パラメータ

型 名前 説明
long val 新しい値

戻り値

型 説明
bool 操作が成功した場合は true、それ以外の場合は false
備考

Value プロパティを直接書き込む場合とは異なり、このメソッドはエラー発生時に例外をスローしません。

実装

IDisposable