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




index
The zero-based index of the overlay for which the attributes are being set.
attributes
An RasterOverlayAttributes object containing the overlay attributes to set.
flags
Flags that determine which attributes to set.
Updates the overlay attributes for the overlay at the specified index.

Syntax

Visual Basic (Declaration) 
Public Sub UpdateOverlayAttributes( _
   ByVal index As Integer, _
   ByVal attributes As RasterOverlayAttributes, _
   ByVal flags As RasterGetSetOverlayAttributesFlags _
) 
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim index As Integer
Dim attributes As RasterOverlayAttributes
Dim flags As RasterGetSetOverlayAttributesFlags
 
instance.UpdateOverlayAttributes(index, attributes, flags)
C# 
public void UpdateOverlayAttributes( 
   int index,
   RasterOverlayAttributes attributes,
   RasterGetSetOverlayAttributesFlags flags
)
Managed Extensions for C++ 
public: void UpdateOverlayAttributes( 
   int index,
   RasterOverlayAttributes* attributes,
   RasterGetSetOverlayAttributesFlags flags
) 
C++/CLI 
public:
void UpdateOverlayAttributes( 
   int index,
   RasterOverlayAttributes^ attributes,
   RasterGetSetOverlayAttributesFlags flags
) 

Parameters

index
The zero-based index of the overlay for which the attributes are being set.
attributes
An RasterOverlayAttributes object containing the overlay attributes to set.
flags
Flags that determine which attributes to set.

Example

For an example, refer to GetOverlayImage.

Remarks

This method can be used to set some or all the overlay attributes. Before calling this metod, initialize the attributes object members with all the attributes to be set or changed.

You do not need to initialize the object variables that you are not setting or changing. For example, if RasterGetSetOverlayAttributesFlags.Origin is not set in flags, you do not need to initialize RasterOverlayAttributes.Origin member of attributes.

There are several attributes in flags and you cannot change only one flag. If you want to change only one flag, you will first have to get all the flags and change only the flag you want. See the example for more information.

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