GetOverlayAttributes Method

Gets one or more overlay attributes for the specified index.

Syntax

public RasterOverlayAttributes GetOverlayAttributes( 
   int index,
   RasterGetSetOverlayAttributesFlags flags
)

public RasterOverlayAttributes GetOverlayAttributes( 
   int index,
   RasterGetSetOverlayAttributesFlags flags
)

 function Leadtools.RasterImage.GetOverlayAttributes( 
   index ,
   flags 
)

public:
RasterOverlayAttributes^ GetOverlayAttributes( 
   int index,
   RasterGetSetOverlayAttributesFlags flags
)

'Declaration
 
Public Function GetOverlayAttributes( _
   ByVal index As Integer, _
   ByVal flags As RasterGetSetOverlayAttributesFlags _
) As RasterOverlayAttributes

'Usage
 
Dim instance As RasterImage
Dim index As Integer
Dim flags As RasterGetSetOverlayAttributesFlags
Dim value As RasterOverlayAttributes
 
value = instance.GetOverlayAttributes(index, flags)

Parameters

index: The zero-based index of the overlay for which to get the attributes.
flags: Flags that determine which attributes to retrieve.

Return Value

An RasterOverlayAttributes object filled with the attribute data requested or null ( Nothing in Visual Basic) if the image does not have an overlay attribute at the specific index.

Remarks

Only the members specified by flags will contain valid values in returned RasterOverlayAttributes retrieved by the method will be updated. The other values are left to the defult value.

For more information, refer to Overlay Overview.

Example

For an example, refer to UpdateOverlayAttributes example.

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

RasterImage Class
RasterImage Members