UseBitPlane Property

Gets or sets a value which determines whether the overlay has a corresponding bitplane in the main image.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public bool UseBitPlane {get; set;}

'Declaration
 
Public Property UseBitPlane As Boolean

'Usage
 
Dim instance As RasterOverlayAttributes
Dim value As Boolean
 
instance.UseBitPlane = value
 
value = instance.UseBitPlane

public bool UseBitPlane {get; set;}

 get_UseBitPlane();
 set_UseBitPlane(value);

public:
property bool UseBitPlane {
   bool get();
   void set (    bool value);
}

Property Value

true if the overlay has a corresponding bitplane in the main image; false, otherwise.

Remarks

If the value of this property is true, then BitPosition should hold the index to the index bitplane.

For more information, refer to Overlay Overview.

Example

For an example, refer to RasterImage.GetOverlayAttributes and RasterImage.UpdateOverlayAttributes.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

RasterOverlayAttributes Class
RasterOverlayAttributes Members