Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.3.5
GetOverlayAttributes Method
See Also 
Leadtools Namespace > RasterImage Class : GetOverlayAttributes Method




index
The zero-based index of the overlay for which to get the attributes.
flags
Flags that determine which attributes to retrieve.
Gets one or more overlay attributes for the specified index.

Syntax

Visual Basic (Declaration) 
Public Function GetOverlayAttributes( _
   ByVal index As Integer, _
   ByVal flags As RasterGetSetOverlayAttributesFlags _
) As RasterOverlayAttributes
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim index As Integer
Dim flags As RasterGetSetOverlayAttributesFlags
Dim value As RasterOverlayAttributes
 
value = instance.GetOverlayAttributes(index, flags)
C# 
public RasterOverlayAttributes GetOverlayAttributes( 
   int index,
   RasterGetSetOverlayAttributesFlags flags
)
Managed Extensions for C++ 
public: RasterOverlayAttributes* GetOverlayAttributes( 
   int index,
   RasterGetSetOverlayAttributesFlags flags
)
C++/CLI 
public:
RasterOverlayAttributes^ GetOverlayAttributes( 
   int index,
   RasterGetSetOverlayAttributesFlags 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.

Example

For an example, refer to UpdateOverlayAttributes example.

Remarks

The retrieved values will be stored in attributes. Only the members retrieved by the method will be updated. The other values are left unchanged.

For more information, refer to Overlay Overview.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also