Class PropInteger

Common examples for a integer properties are Width or Height.

An integer property can limit the range of valid values. The range of possible values can be queried by reading Minimum and Maximum.

The possible values can be further restricted by an increment value or a set of value values. Check IncrementMode, Increment and ValidValueSet for details.

An integer property property supplies hints that can be useful when creating a user interface:

• A Representation
• A Unit

PropInteger instances are created in multiple ways:

• By directly querying a PropertyMap for a float property:
  • Find(PropIdInteger)
  • FindInteger(string)
  • TryFind(PropIdInteger, out PropInteger)
  • TryFindInteger(string, out PropInteger)
• By casting a Property object obtained from one of the functions returning generic property objects:
  • Find(string)
  • TryFind(string, out Property)
  • Features
  • All
  • SelectedProperties

The increment restricts the set of valid values for a integer property.

For example, if the property's minimum value is 0, the maximum is 10, and the increment is 2, 1 is not a valid value for the property

Accessing Increment will throw an exception if IncrementMode is not equal to Increment.

An integer property has 1 of 2 possible increment modes:

The representation can be used as a hint when creating user interfaces

Accessing Increment will throw an exception if IncrementMode is not equal to ValueSet.

If exceptions are not desired when accessing the value, use TryGetValue(out long) or TrySetValue(long).

In contrast to reading the Value property directly, this method does not throw an exception in case of an error.

In contrast to writing the Value property directly, this method does not throw an exception in case of an error.