LEADTOOLS (Leadtools assembly)

GetOverlayAttributes Method

Show in webframe







The zero-based index of the overlay for which to get the attributes.
Flags that determine which attributes to retrieve.
Gets one or more overlay attributes for the specified index.
Syntax
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)
public RasterOverlayAttributes GetOverlayAttributes( 
   int index,
   RasterGetSetOverlayAttributesFlags flags
)
-(LTRasterOverlayAttributes*)getOverlayAttributes:(int)index 
                                            flags:(LTRasterGetSetOverlayAttributesFlags)flags 
                                            error:(NSError**)outError;
            
public RasterOverlayAttributes getOverlayAttributes(
  int index, 
  int flags
)
            
 function Leadtools.RasterImage.GetOverlayAttributes( 
   index ,
   flags 
)
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.
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

See Also

Reference

RasterImage Class
RasterImage Members

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2014 All Rights Reserved. LEAD Technologies, Inc.