Class Handle

Namespace

Rsvg

Assembly

Rsvg-2.0.dll

public class Handle : Object, IDisposable, NativeObject, GTypeProvider, InstanceFactory

Inheritance

object

Object

Handle

Implements

IDisposable

NativeObject

GTypeProvider

InstanceFactory

Inherited Members

Object.Handle

Object.Dispose()

Object.CompatControl(nuint, nint)

Object.InterfaceFindProperty(TypeInterface, string)

Object.InterfaceInstallProperty(TypeInterface, ParamSpec)

Object.AddWeakPointer(ref nint)

Object.BindProperty(string, Object, string, BindingFlags)

Object.BindPropertyFull(string, Object, string, BindingFlags, Closure, Closure)

Object.ForceFloating()

Object.FreezeNotify()

Object.GetData(string)

Object.GetProperty(string, Value)

Object.GetQdata(Quark)

Object.GetValist(string, nint)

Object.Getv(string[], Value[])

Object.IsFloating()

Object.Notify(string)

Object.NotifyByPspec(ParamSpec)

Object.Ref()

Object.RefSink()

Object.RemoveWeakPointer(ref nint)

Object.RunDispose()

Object.SetData(string, nint)

Object.SetProperty(string, Value)

Object.SetQdata(Quark, nint)

Object.SetValist(string, nint)

Object.Setv(string[], Value[])

Object.StealData(string)

Object.StealQdata(Quark)

Object.TakeRef()

Object.ThawNotify()

Object.Unref()

Object.WatchClosure(Closure)

Object.NotifySignal

Object.OnNotify

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Handle(params ConstructArgument[])

[Obsolete("Regular C# constructors on native classes will be removed in a future version. Please see the linked documentation for more details. It contains scenarios and possible solutions to prepare for the upcoming changes.", DiagnosticId = "GirCore1007", UrlFormat = "https://gircore.github.io/docs/integration/diagnostic/1007.html")]
public Handle(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

Handle(CreationData)

[Obsolete("This constructor is a workaround to keep legacy APIs alive. Do not use it.")]
protected Handle(CreationData data)

Parameters

data CreationData

Handle(HandleHandle)

protected Handle(HandleHandle handle)

Parameters

handle HandleHandle

Fields

BaseUriPropertyDefinition

public static readonly Property<string?, Handle> BaseUriPropertyDefinition

Field Value

Property<string, Handle>

DescPropertyDefinition

public static readonly Property<string?, Handle> DescPropertyDefinition

Field Value

Property<string, Handle>

DpiXPropertyDefinition

public static readonly Property<double, Handle> DpiXPropertyDefinition

Field Value

Property<double, Handle>

DpiYPropertyDefinition

public static readonly Property<double, Handle> DpiYPropertyDefinition

Field Value

Property<double, Handle>

EmPropertyDefinition

public static readonly Property<double, Handle> EmPropertyDefinition

Field Value

Property<double, Handle>

ExPropertyDefinition

public static readonly Property<double, Handle> ExPropertyDefinition

Field Value

Property<double, Handle>

FlagsPropertyDefinition

public static readonly Property<HandleFlags, Handle> FlagsPropertyDefinition

Field Value

Property<HandleFlags, Handle>

HeightPropertyDefinition

public static readonly Property<int, Handle> HeightPropertyDefinition

Field Value

Property<int, Handle>

MetadataPropertyDefinition

public static readonly Property<string?, Handle> MetadataPropertyDefinition

Field Value

Property<string, Handle>

TitlePropertyDefinition

public static readonly Property<string?, Handle> TitlePropertyDefinition

Field Value

Property<string, Handle>

WidthPropertyDefinition

public static readonly Property<int, Handle> WidthPropertyDefinition

Field Value

Property<int, Handle>

Properties

BaseUri

public string? BaseUri { get; set; }

Property Value

string

Desc

public string? Desc { get; }

Property Value

string

DpiX

public double DpiX { get; set; }

Property Value

double

DpiY

public double DpiY { get; set; }

Property Value

double

Em

public double Em { get; }

Property Value

double

Ex

public double Ex { get; }

Property Value

double

Flags

public HandleFlags Flags { get; }

Property Value

HandleFlags

Height

public int Height { get; }

Property Value

int

Metadata

public string? Metadata { get; }

Property Value

string

Title

public string? Title { get; }

Property Value

string

Width

public int Width { get; }

Property Value

int

Methods

Close()

public bool Close()

Returns

bool

GetBaseUri()

[Version("2.8")]
public string GetBaseUri()

Returns

string

GetDesc()

[Version("2.4")]
public string? GetDesc()

Returns

string

GetDimensions(out DimensionData)

[Version("2.14")]
public void GetDimensions(out DimensionData dimensionData)

Parameters

dimensionData DimensionData

GetDimensionsSub(out DimensionData, string?)

[Version("2.22")]
public bool GetDimensionsSub(out DimensionData dimensionData, string? id)

Parameters

dimensionData DimensionData

id string

Returns

bool

GetGType()

public static Type GetGType()

Returns

Type

GetGeometryForElement(string?, out Rectangle, out Rectangle)

[Version("2.46")]
public bool GetGeometryForElement(string? id, out Rectangle outInkRect, out Rectangle outLogicalRect)

Parameters

id string

outInkRect Rectangle

outLogicalRect Rectangle

Returns

bool

GetGeometryForLayer(string?, Rectangle, out Rectangle, out Rectangle)

[Version("2.46")]
public bool GetGeometryForLayer(string? id, Rectangle viewport, out Rectangle outInkRect, out Rectangle outLogicalRect)

Parameters

id string

viewport Rectangle

outInkRect Rectangle

outLogicalRect Rectangle

Returns

bool

GetIntrinsicDimensions(out bool, out Length, out bool, out Length, out bool, out Rectangle)

[Version("2.46")]
public void GetIntrinsicDimensions(out bool outHasWidth, out Length outWidth, out bool outHasHeight, out Length outHeight, out bool outHasViewbox, out Rectangle outViewbox)

Parameters

outHasWidth bool

outWidth Length

outHasHeight bool

outHeight Length

outHasViewbox bool

outViewbox Rectangle

GetIntrinsicSizeInPixels(out double, out double)

[Version("2.52")]
public bool GetIntrinsicSizeInPixels(out double outWidth, out double outHeight)

Parameters

outWidth double

outHeight double

Returns

bool

GetMetadata()

[Version("2.9")]
public string? GetMetadata()

Returns

string

GetPixbuf()

public Pixbuf? GetPixbuf()

Returns

Pixbuf

GetPixbufAndError()

[Version("2.59")]
public Pixbuf? GetPixbufAndError()

Returns

Pixbuf

GetPixbufSub(string?)

[Version("2.14")]
public Pixbuf? GetPixbufSub(string? id)

Parameters

id string

Returns

Pixbuf

GetPositionSub(out PositionData, string?)

[Version("2.22")]
public bool GetPositionSub(out PositionData positionData, string? id)

Parameters

positionData PositionData

id string

Returns

bool

GetTitle()

[Version("2.4")]
public string? GetTitle()

Returns

string

HasSub(string)

[Version("2.22")]
public bool HasSub(string id)

Parameters

id string

Returns

bool

InternalSetTesting(bool)

public void InternalSetTesting(bool testing)

Parameters

testing bool

New()

public static Handle New()

Returns

Handle

NewFromData(Span<byte>)

[Version("2.14")]
public static Handle NewFromData(Span<byte> data)

Parameters

data Span<byte>

Returns

Handle

NewFromFile(string)

[Version("2.14")]
public static Handle NewFromFile(string filename)

Parameters

filename string

Returns

Handle

NewFromGfileSync(File, HandleFlags, Cancellable?)

[Version("2.32")]
public static Handle NewFromGfileSync(File file, HandleFlags flags, Cancellable? cancellable)

Parameters

file File

flags HandleFlags

cancellable Cancellable

Returns

Handle

NewFromPointer(nint, bool)

Creates a new managed Handle instance for a given pointer.

public static Handle NewFromPointer(nint ptr, bool ownsHandle)

Parameters

ptr nint

ownsHandle bool

Returns

Handle

NewFromStreamSync(InputStream, File?, HandleFlags, Cancellable?)

[Version("2.32")]
public static Handle NewFromStreamSync(InputStream inputStream, File? baseFile, HandleFlags flags, Cancellable? cancellable)

Parameters

inputStream InputStream

baseFile File

flags HandleFlags

cancellable Cancellable

Returns

Handle

NewWithFlags(HandleFlags)

[Version("2.36")]
public static Handle NewWithFlags(HandleFlags flags)

Parameters

flags HandleFlags

Returns

Handle

NewWithProperties(ConstructArgument[])

Creates a new Handle and sets the properties specified by the construct arguments.

public static Handle NewWithProperties(ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

The properties to set.

Returns

Handle

ReadStreamSync(InputStream, Cancellable?)

[Version("2.32")]
public bool ReadStreamSync(InputStream stream, Cancellable? cancellable)

Parameters

stream InputStream

cancellable Cancellable

Returns

bool

RenderCairo(Context)

[Version("2.14")]
public bool RenderCairo(Context cr)

Parameters

cr Context

Returns

bool

RenderCairoSub(Context, string?)

[Version("2.14")]
public bool RenderCairoSub(Context cr, string? id)

Parameters

cr Context

id string

Returns

bool

RenderDocument(Context, Rectangle)

[Version("2.46")]
public bool RenderDocument(Context cr, Rectangle viewport)

Parameters

cr Context

viewport Rectangle

Returns

bool

RenderElement(Context, string?, Rectangle)

[Version("2.46")]
public bool RenderElement(Context cr, string? id, Rectangle elementViewport)

Parameters

cr Context

id string

elementViewport Rectangle

Returns

bool

RenderLayer(Context, string?, Rectangle)

[Version("2.46")]
public bool RenderLayer(Context cr, string? id, Rectangle viewport)

Parameters

cr Context

id string

viewport Rectangle

Returns

bool

SetBaseGfile(File)

[Version("2.32")]
public void SetBaseGfile(File baseFile)

Parameters

baseFile File

SetBaseUri(string)

[Version("2.9")]
public void SetBaseUri(string baseUri)

Parameters

baseUri string

SetCancellableForRendering(Cancellable?)

[Version("2.59.0")]
public void SetCancellableForRendering(Cancellable? cancellable)

Parameters

cancellable Cancellable

SetDpi(double)

[Version("2.8")]
public void SetDpi(double dpi)

Parameters

dpi double

SetDpiXY(double, double)

[Version("2.8")]
public void SetDpiXY(double dpiX, double dpiY)

Parameters

dpiX double

dpiY double

SetSizeCallback(SizeFunc?)

public void SetSizeCallback(SizeFunc? sizeFunc)

Parameters

sizeFunc SizeFunc

A callback. If it raises an exception the application will terminate. To receive this unhandled exception see SetHandler(Action<Exception>?).

SetStylesheet(Span<byte>)

[Version("2.48")]
public bool SetStylesheet(Span<byte> css)

Parameters

css Span<byte>

Returns

bool

Write(Span<byte>)

public bool Write(Span<byte> buf)

Parameters

buf Span<byte>

Returns

bool