←Select platform

GetOverlayAttributes Method

Summary

Gets one or more overlay attributes for the specified index.

Syntax

C#
VB
Java
Objective-C
WinRT C#
C++
public Leadtools.RasterOverlayAttributes GetOverlayAttributes(  
   int index, 
   Leadtools.RasterGetSetOverlayAttributesFlags flags 
) 
Public Function GetOverlayAttributes( _ 
   ByVal index As Integer, _ 
   ByVal flags As Leadtools.RasterGetSetOverlayAttributesFlags _ 
) As Leadtools.RasterOverlayAttributes 
public Leadtools.RasterOverlayAttributes GetOverlayAttributes(  
   int index, 
   Leadtools.RasterGetSetOverlayAttributesFlags flags 
) 
- (nullable LTRasterOverlayAttributes *)getOverlayAttributesAtIndex:(NSInteger)index  
                                                              flags:(LTRasterGetSetOverlayAttributesFlags)flags  
                                                              error:(NSError **)error 
             
public RasterOverlayAttributes getOverlayAttributes( 
  int index,  
  int flags 
) 
             
 function Leadtools.RasterImage.GetOverlayAttributes(  
   index , 
   flags  
) 
public: 
Leadtools.RasterOverlayAttributes^ GetOverlayAttributes(  
   int index, 
   Leadtools.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 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

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
Leadtools Assembly
Introduction
Getting Started
Namespaces
Leadtools.ImageProcessing Namespace
Leadtools Namespace
Classes
LeadBufferStream
LeadCollection<T>
LeadFileStream
LeadLengthDConverter
LeadLengthDHelper
LeadMatrixConverter
LeadPointConverter
LeadPointDConverter
LeadPointDHelper
LeadPointHelper
LeadRectConverter
LeadRectDConverter
LeadRectDHelper
LeadRectHelper
LeadSizeConverter
LeadSizeDConverter
LeadSizeDHelper
LeadSizeHelper
LeadStream
LeadStreamFactory
LeadtoolsException
NotifyLeadCollectionChangedEventArgs
RasterBufferConverter
RasterBufferResize
RasterCollectionEventArgs<T>
RasterCollection<T>
RasterColor16Helper
RasterColorHelper
RasterColorSpace
RasterColorTypeConverter
RasterCommentMetadata
RasterCurve
RasterDefaults
RasterException
RasterHsvColorHelper
RasterImage
Members
RasterImage Constructors
Methods
Access Method
AccessData Method
AddBeziersToRegion Method
AddBorderToRegion Method
AddColorHsvRangeToRegion Method
AddColorRgbRangeToRegion Method
AddColorToRegion Method
AddCurveToRegion Method
AddEllipseToRegion Method
AddMagicWandToRegion Method
AddMaskToRegion Method
AddPage Method
AddPages Method
AddPolygonToRegion Method
AddRectangleToRegion Method
AddRoundRectangleToRegion Method
CalculatePaintModeRectangle Method
CalculateRegionArea Method
CalculateRegionMaximumClipSegments Method
ChangeCompression Method
ChangeFromDib Method
ChangeHeight Method
ChangeToDib Method
ChangeViewPerspective Method
Clone Method
CloneAll Method
CopyData Method
CopyMetadataTo Method
CopyPaletteTo Method
Create(int32,int32,int32,int32,rastercolor) Method
CreateAlphaImage Method
CreateFromArray Method
CreateFromBuffer Method
CreateFromIntPtr Method
CreateFromYUVData Method
CreateGrayscale Method
CreateMaskFromRegion Method
CreateThumbnail Method
DisableEvents Method
DitherLine Method
EnableEvents Method
FlipRegion Method
FlipViewPerspective Method
FromDib Method
FromDibArray Method
FromDibPtr Method
GetImageHeightDpi Method
GetImageSizeDpi Method
GetImageWidthDpi Method
GetLookupTable Method
GetLookupTable16 Method
GetObjectData Method
GetOverlayAttributes Method
GetOverlayImage Method
GetPaintLookupTable Method
GetPaintLookupTable16 Method
GetPalette Method
GetPixel Method
GetPixelColor Method
GetPixelData Method
GetRegion Method
GetRegionBounds Method
GetRegionBoundsClipped Method
GetRegionClipSegments Method
GetRow Method
GetRowColumn Method
GetRowColumnCompressed Method
GetRowCompressed Method
GetTrueColorValue Method
GetYUVData Method
InsertPage Method
InsertPages Method
MakeRegionEmpty Method
OffsetRegion Method
OnChanged Method
PointFromImage Method
PointToImage Method
RectangleFromImage Method
RectangleToImage Method
RegionContains Method
Release Method
ReleaseData Method
RemoveAllPages Method
RemovePageAt Method
RemovePages Method
ReplacePage Method
ReplacePages Method
ReverseRegion Method
RotateViewPerspective Method
SetAlphaImage Method
SetLookupTable Method
SetLookupTable16 Method
SetOverlayImage Method
SetOverlayImageSize Method
SetPaintLookupTable Method
SetPalette Method
SetPixel Method
SetPixelColor Method
SetPixelData Method
SetRegion Method
SetRow Method
SetRowColumn Method
SetRowColumnCompressed Method
SetRowCompressed Method
SetRowSegments Method
SetUserData Method
SetYUVData Method
StartDithering Method
StopDithering Method
ToDib Method
ToDib (WinRT) Method
ToDibArray Method
TranslateColor Method
Underlay Method
UpdateOverlayAttributes Method
UpdateOverlayBits Method
WindowLevel Method
WindowLevelExt Method
Dispose Method
Finalize Method
Properties
Events
Fields
RasterImageAllocateData
RasterImageAnimator
RasterImageChangedEventArgs
RasterImagePagesChangedEventArgs
RasterImageResize
RasterImageResizeEventArgs
RasterMarkerMetadata
RasterMetadata
RasterMetadataRationalHelper
RasterMetadataURationalHelper
RasterOverlayAttributes
RasterPalette
RasterRegion
RasterRegionXForm
RasterRleCompressor
RasterSupport
RasterTagMetadata
Delegates
Enumerations
Interfaces
Structures
Assemblies
Click or drag to resize