Class MagickSettings

Namespace

ImageMagick

Assembly

Magick.NET-Q16-AnyCPU.dll

Class that contains various settings.

public class MagickSettings : IMagickSettings<ushort>

Inheritance

object

MagickSettings

Implements

IMagickSettings<ushort>

Derived

MagickReadSettings

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Affine

Gets or sets the affine to use when annotating with text or drawing.

public IDrawableAffine? Affine { get; set; }

Property Value

IDrawableAffine

AntiAlias

Gets or sets a value indicating whether anti-aliasing should be enabled (default true).

public bool AntiAlias { get; set; }

Property Value

bool

BackgroundColor

Gets or sets the background color.

public IMagickColor<ushort>? BackgroundColor { get; set; }

Property Value

IMagickColor<ushort>

BorderColor

Gets or sets the border color.

public IMagickColor<ushort>? BorderColor { get; set; }

Property Value

IMagickColor<ushort>

ColorSpace

Gets or sets the color space.

public ColorSpace? ColorSpace { get; set; }

Property Value

ColorSpace

ColorType

Gets or sets the color type of the image.

public ColorType? ColorType { get; set; }

Property Value

ColorType

Compression

Gets or sets the compression method to use.

public CompressionMethod? Compression { get; set; }

Property Value

CompressionMethod

Debug

Gets or sets a value indicating whether printing of debug messages from ImageMagick is enabled when a debugger is attached.

public bool Debug { get; set; }

Property Value

bool

Density

Gets or sets the vertical and horizontal resolution in pixels.

public Density? Density { get; set; }

Property Value

Density

Depth

Gets or sets the depth (bits allocated to red/green/blue components).

public int Depth { get; set; }

Property Value

int

Endian

Gets or sets the endianness (little like Intel or big like SPARC) for image formats which support endian-specific options.

public Endian? Endian { get; set; }

Property Value

Endian

Extract

Gets or sets the specified area to extract from the image.

protected IMagickGeometry? Extract { get; set; }

Property Value

IMagickGeometry

FillColor

Gets or sets the fill color.

public IMagickColor<ushort>? FillColor { get; set; }

Property Value

IMagickColor<ushort>

FillPattern

Gets or sets the fill pattern.

public IMagickImage<ushort>? FillPattern { get; set; }

Property Value

IMagickImage<ushort>

FillRule

Gets or sets the rule to use when filling drawn objects.

public FillRule? FillRule { get; set; }

Property Value

FillRule

Font

Gets or sets the text rendering font.

public string? Font { get; set; }

Property Value

string

FontFamily

Gets or sets the text font family.

public string? FontFamily { get; set; }

Property Value

string

FontPointsize

Gets or sets the font point size.

public double FontPointsize { get; set; }

Property Value

double

FontStyle

Gets or sets the font style.

public FontStyleType? FontStyle { get; set; }

Property Value

FontStyleType

FontWeight

Gets or sets the font weight.

public FontWeight? FontWeight { get; set; }

Property Value

FontWeight

Format

Gets or sets the the format of the image.

public MagickFormat? Format { get; set; }

Property Value

MagickFormat

Interlace

Gets or sets the interlace method.

public Interlace? Interlace { get; set; }

Property Value

Interlace

Monochrome

Gets or sets a value indicating whether a monochrome reader should be used.

protected bool Monochrome { get; set; }

Property Value

bool

NumberScenes

Gets or sets the number of scenes.

protected int NumberScenes { get; set; }

Property Value

int

Page

Gets or sets the preferred size and location of an image canvas.

public IMagickGeometry? Page { get; set; }

Property Value

IMagickGeometry

Scene

Gets or sets the active scene.

protected int Scene { get; set; }

Property Value

int

Scenes

Gets or sets scenes of the image.

protected string? Scenes { get; set; }

Property Value

string

Size

Gets or sets the size of the image.

protected string? Size { get; set; }

Property Value

string

StrokeAntiAlias

Gets or sets a value indicating whether stroke anti-aliasing is enabled or disabled.

public bool StrokeAntiAlias { get; set; }

Property Value

bool

StrokeColor

Gets or sets the color to use when drawing object outlines.

public IMagickColor<ushort>? StrokeColor { get; set; }

Property Value

IMagickColor<ushort>

StrokeDashArray

Gets or sets the pattern of dashes and gaps used to stroke paths. This represents a zero-terminated array of numbers that specify the lengths of alternating dashes and gaps in pixels. If a zero value is not found it will be added. If an odd number of values is provided, then the list of values is repeated to yield an even number of values.

public IEnumerable<double>? StrokeDashArray { get; set; }

Property Value

IEnumerable<double>

StrokeDashOffset

Gets or sets the distance into the dash pattern to start the dash (default 0) while drawing using a dash pattern,.

public double StrokeDashOffset { get; set; }

Property Value

double

StrokeLineCap

Gets or sets the shape to be used at the end of open subpaths when they are stroked.

public LineCap? StrokeLineCap { get; set; }

Property Value

LineCap

StrokeLineJoin

Gets or sets the shape to be used at the corners of paths (or other vector shapes) when they are stroked.

public LineJoin? StrokeLineJoin { get; set; }

Property Value

LineJoin

StrokeMiterLimit

Gets or sets the miter limit. When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'. The default value is 4.

public int StrokeMiterLimit { get; set; }

Property Value

int

StrokePattern

Gets or sets the pattern image to use while stroking object outlines.

public IMagickImage<ushort>? StrokePattern { get; set; }

Property Value

IMagickImage<ushort>

StrokeWidth

Gets or sets the stroke width for drawing lines, circles, ellipses, etc.

public double StrokeWidth { get; set; }

Property Value

double

TextAntiAlias

Gets or sets a value indicating whether Postscript and TrueType fonts should be anti-aliased (default true).

public bool TextAntiAlias { get; set; }

Property Value

bool

TextDirection

Gets or sets text direction (right-to-left or left-to-right).

public TextDirection? TextDirection { get; set; }

Property Value

TextDirection

TextEncoding

Gets or sets the text annotation encoding (e.g. "UTF-16").

public Encoding? TextEncoding { get; set; }

Property Value

Encoding

TextGravity

Gets or sets the text annotation gravity.

public Gravity? TextGravity { get; set; }

Property Value

Gravity

TextInterlineSpacing

Gets or sets the text inter-line spacing.

public double TextInterlineSpacing { get; set; }

Property Value

double

TextInterwordSpacing

Gets or sets the text inter-word spacing.

public double TextInterwordSpacing { get; set; }

Property Value

double

TextKerning

Gets or sets the text inter-character kerning.

public double TextKerning { get; set; }

Property Value

double

TextUnderColor

Gets or sets the text undercolor box.

public IMagickColor<ushort>? TextUnderColor { get; set; }

Property Value

IMagickColor<ushort>

Verbose

Gets or sets a value indicating whether verbose output os turned on or off.

public bool Verbose { get; set; }

Property Value

bool

Methods

CopyFrom(MagickSettings)

Copies the settings from the specified MagickSettings.

protected void CopyFrom(MagickSettings settings)

Parameters

settings MagickSettings

The settings to copy the data from.

GetDefine(MagickFormat, string)

Returns the value of a format-specific option.

public string? GetDefine(MagickFormat format, string name)

Parameters

format MagickFormat

The format to get the option for.

name string

The name of the option.

Returns

string

The value of a format-specific option.

GetDefine(string)

Returns the value of a format-specific option.

public string? GetDefine(string name)

Parameters

name string

The name of the option.

Returns

string

The value of a format-specific option.

GetOption(string)

Gets an image option.

protected string? GetOption(string key)

Parameters

key string

The key of the option.

Returns

string

The value of the option.

RemoveDefine(MagickFormat, string)

Removes the define with the specified name.

public void RemoveDefine(MagickFormat format, string name)

Parameters

format MagickFormat

The format to set the define for.

name string

The name of the define.

RemoveDefine(string)

Removes the define with the specified name.

public void RemoveDefine(string name)

Parameters

name string

The name of the define.

SetDefine(MagickFormat, string, bool)

Sets a format-specific option.

public void SetDefine(MagickFormat format, string name, bool flag)

Parameters

format MagickFormat

The format to set the define for.

name string

The name of the define.

flag bool

The value of the define.

SetDefine(MagickFormat, string, int)

Sets a format-specific option.

public void SetDefine(MagickFormat format, string name, int value)

Parameters

format MagickFormat

The format to set the define for.

name string

The name of the define.

value int

The value of the define.

SetDefine(MagickFormat, string, string)

Sets a format-specific option.

public void SetDefine(MagickFormat format, string name, string value)

Parameters

format MagickFormat

The format to set the option for.

name string

The name of the option.

value string

The value of the option.

SetDefine(string, string)

Sets a format-specific option.

public void SetDefine(string name, string value)

Parameters

name string

The name of the option.

value string

The value of the option.

SetDefines(IDefines)

Sets format-specific options with the specified defines.

public void SetDefines(IDefines defines)

Parameters

defines IDefines

The defines to set.

SetOption(string, string?)

Sets an image option.

protected void SetOption(string key, string? value)

Parameters

key string

The key of the option.

value string

The value of the option.