ChannelIndex Property (SetColorChannelCommand)

In This Topic

Gets or sets the index of the channel if single channel image is specified.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

<DescriptionAttribute("The index of the channel if single channel image is specified.")>
<DefaultValueAttribute(0)>
Public Property ChannelIndex As System.Int32

[Description("The index of the channel if single channel image is specified.")]
[DefaultValue(0)]
public System.Int32 ChannelIndex { get; set; }

[Description("The index of the channel if single channel image is specified.")]
[DefaultValue(0)]
public: __property System.Int32 get_ChannelIndex();
public: __property void set_ChannelIndex(
   System.Int32 value
);

[Description("The index of the channel if single channel image is specified.")]
[DefaultValue(0)]
public:
property System.Int32 ChannelIndex {
   System.Int32 get();
   void set(System.Int32 value);
}

Property Value

Valid values are all non negative integers.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	Thrown if new channel index is negative.
System.InvalidOperationException	Thrown if Channels has length greater than 1.

Remarks

In order to set all significant channels, use Channels.

Requirements

Target Platforms: .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

SetColorChannelCommand Class
SetColorChannelCommand Members

Send Feedback