Used to pass a value, or an array of values, to an image encoder.
Declaration Syntax| C# | Visual Basic |
public sealed class EncoderParameter : IDisposable
Public NotInheritable Class EncoderParameter _ Implements IDisposable
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | EncoderParameter(Encoder, Byte) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and one unsigned 8-bit integer.
Sets the ValueType property to ValueTypeByte, and sets the NumberOfValues property to 1.
|
| EncoderParameter(Encoder, Byte, Boolean) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and one 8-bit value.
Sets the ValueType property to ValueTypeUndefined or ValueTypeByte, and sets the NumberOfValues property to 1.
|
| EncoderParameter(Encoder, Int16) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and one, 16-bit integer.
Sets the ValueType property to ValueTypeShort, and sets the NumberOfValues property to 1.
|
| EncoderParameter(Encoder, Int64) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and one 64-bit integer.
Sets the ValueType property to ValueTypeLong (32 bits), and sets the NumberOfValues property to 1.
|
| EncoderParameter(Encoder, Int32, Int32) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and a pair of 32-bit integers.
The pair of integers represents a fraction, the first integer being the numerator, and the second integer being the denominator.
Sets the ValueType property to ValueTypeRational, and sets the NumberOfValues property to 1.
|
| EncoderParameter(Encoder, Int64, Int64) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and a pair of 64-bit integers.
The pair of integers represents a range of integers, the first integer being the smallest number in the range, and the second integer being the largest number in the range.
Sets the ValueType property to ValueTypeLongRange, and sets the NumberOfValues property to 1.
|
| EncoderParameter(Encoder, Int32, Int32, Int32, Int32) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and four, 32-bit integers.
The four integers represent a range of fractions.
The first two integers represent the smallest fraction in the range, and the remaining two integers represent the largest fraction in the range.
Sets the ValueType property to ValueTypeRationalRange, and sets the NumberOfValues property to 1.
|
| EncoderParameter(Encoder, String) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and a character string.
The string is converted to a null-terminated ASCII string before it is stored in the EncoderParameter object
Sets the ValueType property to ValueTypeAscii, and sets the NumberOfValues property to the length of the ASCII string including the NULL terminator.
|
| EncoderParameter(Encoder, array<Byte>[]()[][]) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and an array of unsigned 8-bit integers.
Sets the ValueType property to ValueTypeByte, and sets the NumberOfValues property to the number of elements in the array.
|
| EncoderParameter(Encoder, array<Byte>[]()[][], Boolean) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and an array of bytes.
Sets the ValueType property to ValueTypeUndefined or ValueTypeByte, and sets the NumberOfValues property to the number of elements in the array.
|
| EncoderParameter(Encoder, array<Int16>[]()[][]) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and an array of 16-bit integers.
Sets the ValueType property to ValueTypeShort, and sets the NumberOfValues property to the number of elements in the array.
|
| EncoderParameter(Encoder, array<Int64>[]()[][]) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and an array of 64-bit integers.
Sets the ValueType property to ValueTypeLong (32-bit), and sets the NumberOfValues property to the number of elements in the array.
|
| EncoderParameter(Encoder, array<Int32>[]()[][], array<Int32>[]()[][]) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and two arrays of 32-bit integers.
The two arrays represent an array of fractions.
Sets the ValueType property to ValueTypeRational, and sets the NumberOfValues property to the number of elements in the numerator array, which must be the same as the number of elements in the denominator array.
|
| EncoderParameter(Encoder, array<Int64>[]()[][], array<Int64>[]()[][]) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and two arrays of 64-bit integers.
The two arrays represent an array integer ranges.
Sets the ValueType property to ValueTypeLongRange, and sets the NumberOfValues property to the number of elements in the rangebegin array, which must be the same as the number of elements in the rangeend array.
|
| EncoderParameter(Encoder, array<Int32>[]()[][], array<Int32>[]()[][], array<Int32>[]()[][], array<Int32>[]()[][]) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and four arrays of 32-bit integers.
The four arrays represent an array rational ranges.
A rational range is the set of all fractions from a minimum fractional value through a maximum fractional value.
Sets the ValueType property to ValueTypeRationalRange, and sets the NumberOfValues property to the number of elements in the numerator1 array, which must be the same as the number of elements in the other three arrays.
|
| EncoderParameter(Encoder, Int32, Int32, Int32) |
Initializes a new instance of the EncoderParameter class with the specified Encoder object and three integers that specify the number of values, the data type of the values, and a pointer to the values stored in the EncoderParameter object.
|
| Dispose()()()() |
Releases all resources used by this EncoderParameter object.
|
 | Encoder |
Gets or sets the Encoder object associated with this EncoderParameter object.
The Encoder object encapsulates the globally unique identifier (GUID) that specifies the category (for example Quality, ColorDepth, or Compression) of the parameter stored in this EncoderParameter object.
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Overrides Object.Finalize()()()().) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| NumberOfValues |
Gets the number of elements in the array of values stored in this EncoderParameter object.
|
| ToString()()()() | (Inherited from Object.) |
| Type |
Gets the data type of the values stored in this EncoderParameter object.
|
| ValueType |
Gets the data type of the values stored in this EncoderParameter object.
|
Remarks
You can also use an EncoderParameter object to receive a list of possible values supported by a particular parameter of a particular image encoder.
| Platforms Supported | |
|---|---|
| Windows Mobile | Windows Mobile Version 5.0 and later |
| Windows Embedded Compact | Windows CE 4.1 and later |
Inheritance Hierarchy| Object | |
 | EncoderParameter |