BitmapDataExtensionsTrySetPalette Method

Tries to the set the specified palette for this IWritableBitmapData.

Definition

Namespace: KGySoft.Drawing.Imaging
Assembly: KGySoft.Drawing.Core (in KGySoft.Drawing.Core.dll) Version: 8.2.0

C#

public static bool TrySetPalette(
	this IWritableBitmapData bitmapData,
	Palette palette
)

VB

<ExtensionAttribute>
Public Shared Function TrySetPalette ( 
	bitmapData As IWritableBitmapData,
	palette As Palette
) As Boolean

C++

public:
[ExtensionAttribute]
static bool TrySetPalette(
	IWritableBitmapData^ bitmapData, 
	Palette^ palette
)

F#

[<ExtensionAttribute>]
static member TrySetPalette : 
        bitmapData : IWritableBitmapData * 
        palette : Palette -> bool

Parameters

bitmapData IWritableBitmapData: The IWritableBitmapData whose Palette should be set.
palette Palette: A Palette instance to set.

Return Value

Boolean
palette can be set as the Palette of this bitmapData; otherwise, .

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IWritableBitmapData. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Setting may fail if bitmapData PixelFormat is not an indexed one, the number of entries in palette is less than Count of the current Palette, the number of entries in palette is larger than the possible maximum number of colors of the current PixelFormat, or when the current IWritableBitmapData does not support setting the palette.

The Palette.BackColor and Palette.AlphaThreshold properties of the Palette property will continue to return the same value as the original BackColor and AlphaThreshold values of this bitmapData.

Exceptions

ArgumentNullException

bitmapData is .