GrapeCity.Documents.DX.Direct2D.Properties

Class Properties

Namespace

GrapeCity.Documents.DX.Direct2D

Assembly

GcDocs.DX.Windows.dll

ID2D1Properties

[Guid("483473d7-cd46-4f9d-9d3a-3112aa80159d")]
public class Properties : ComObject, IDisposable, IUnknown

Inheritance

object

DisposeBase

CppObject

ComObject

Properties

Implements

System.IDisposable

IUnknown

Effect

Inherited Members

ComObject.QueryInterface(Guid, out IntPtr)

ComObject.QueryInterfaceOrNull(Guid)

ComObject.EqualsComObject<T>(T, T)

ComObject.QueryInterface<T>()

ComObject.As<T>(object)

ComObject.As<T>(IntPtr)

ComObject.QueryInterface<T>(object)

ComObject.QueryInterfaceOrNull<T>(IntPtr)

ComObject.QueryInterfaceOrNull<T>()

ComObject.QueryInterfaceFrom<T>(T)

ComObject.Dispose(bool)

ComObject.NativePointerUpdating()

ComObject.NativePointerUpdated(IntPtr)

CppObject.FromTemp(CppObject)

CppObject.FromTemp(IntPtr)

CppObject.FromPointer<T>(IntPtr)

CppObject.ToCallbackPtr<TCallback>(ICallbackable)

CppObject.Tag

CppObject.NativePointer

DisposeBase.Dispose()

DisposeBase.IsDisposed

DisposeBase.Disposing

DisposeBase.Disposed

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

Properties(IntPtr)

Initializes a new instance of the Properties class.

public Properties(IntPtr nativePtr)

Parameters

nativePtr System.IntPtr

The native pointer.

Properties

Cached

Gets or sets Cached property.

public bool Cached { get; set; }

Property Value

bool

Methods

GetBoolValue(int)

Gets the value of the specified property by index.

public bool GetBoolValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

bool

The value of the specified property by index.

GetBoolValueByName(string)

Gets the value of the specified property by name.

public bool GetBoolValueByName(string name)

Parameters

name string

The name of the property.

Returns

bool

The value of the specified property by name.

GetColorFValue(int)

Gets the value of the specified property by index.

public ColorF GetColorFValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

ColorF

The value of the specified property by index.

GetColorFValueByName(string)

Gets the value of the specified property by name.

public ColorF GetColorFValueByName(string name)

Parameters

name string

The name of the property.

Returns

ColorF

The value of the specified property by name.

GetComObjectValue<T>(int)

Gets the value of the specified property by index.

public T GetComObjectValue<T>(int index) where T : ComObject

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

T

The value of the specified property by index.

Type Parameters

T

GetComObjectValueByName<T>(string)

Gets the value of the specified property by name.

public T GetComObjectValueByName<T>(string name) where T : ComObject

Parameters

name string

The name of the property.

Returns

T

The value of the specified property by name.

Type Parameters

T

GetEnumValue<T>(int)

Gets the value of the specified property by index.

public T GetEnumValue<T>(int index) where T : struct

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

T

The value of the specified property by index.

Type Parameters

T

GetEnumValueByName<T>(string)

Gets the value of the specified property by name.

public T GetEnumValueByName<T>(string name) where T : struct

Parameters

name string

The name of the property.

Returns

T

The value of the specified property by name.

Type Parameters

T

GetFloatValue(int)

Gets the value of the specified property by index.

public float GetFloatValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

float

The value of the specified property by index.

GetFloatValueByName(string)

Gets the value of the specified property by name.

public float GetFloatValueByName(string name)

Parameters

name string

The name of the property.

Returns

float

The value of the specified property by name.

GetGuidValue(int)

Gets the value of the specified property by index.

public Guid GetGuidValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

System.Guid

The value of the specified property by index.

GetGuidValueByName(string)

Gets the value of the specified property by name.

public Guid GetGuidValueByName(string name)

Parameters

name string

The name of the property.

Returns

System.Guid

The value of the specified property by name.

GetIntValue(int)

Gets the value of the specified property by index.

public int GetIntValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

int

The value of the specified property by index.

GetIntValueByName(string)

Gets the value of the specified property by name.

public int GetIntValueByName(string name)

Parameters

name string

The name of the property.

Returns

int

The value of the specified property by name.

GetMatrix3x2Value(int)

Gets the value of the specified property by index.

public Matrix3x2 GetMatrix3x2Value(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

Matrix3x2

The value of the specified property by index.

GetMatrix3x2ValueByName(string)

Gets the value of the specified property by name.

public Matrix3x2 GetMatrix3x2ValueByName(string name)

Parameters

name string

The name of the property.

Returns

Matrix3x2

The value of the specified property by name.

GetMatrix4x4Value(int)

Gets the value of the specified property by index.

public Matrix4x4 GetMatrix4x4Value(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

Matrix4x4

The value of the specified property by index.

GetMatrix4x4ValueByName(string)

Gets the value of the specified property by name.

public Matrix4x4 GetMatrix4x4ValueByName(string name)

Parameters

name string

The name of the property.

Returns

Matrix4x4

The value of the specified property by name.

GetMatrix5x4Value(int)

Gets the value of the specified property by index.

public Matrix5x4 GetMatrix5x4Value(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

Matrix5x4

The value of the specified property by index.

GetMatrix5x4ValueByName(string)

Gets the value of the specified property by name.

public Matrix5x4 GetMatrix5x4ValueByName(string name)

Parameters

name string

The name of the property.

Returns

Matrix5x4

The value of the specified property by name.

GetPoint2FValue(int)

Gets the value of the specified property by index.

public Point2F GetPoint2FValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

Point2F

The value of the specified property by index.

GetPoint2FValueByName(string)

Gets the value of the specified property by name.

public Point2F GetPoint2FValueByName(string name)

Parameters

name string

The name of the property.

Returns

Point2F

The value of the specified property by name.

GetPropertyCount()

unsigned int ID2D1Properties::GetPropertyCount()

public int GetPropertyCount()

Returns

int

GetPropertyIndex(string)

unsigned int ID2D1Properties::GetPropertyIndex([In] const wchar_t* name)

public int GetPropertyIndex(string name)

Parameters

name string

Returns

int

GetPropertyName(int, IntPtr, int)

HRESULT ID2D1Properties::GetPropertyName([In] unsigned int index,[Out, Buffer] wchar_t* name,[In] unsigned int nameCount)

public void GetPropertyName(int index, IntPtr name, int nameCount)

Parameters

index int

name System.IntPtr

nameCount int

GetPropertyName(int)

Gets the number of characters for the given property name.

public string GetPropertyName(int index)

Parameters

index int

The index of the property for which the name is being returned.

Returns

string

The name of the property

Remarks

This method returns an empty string if index is invalid.

GetPropertyNameLength(int)

unsigned int ID2D1Properties::GetPropertyNameLength([In] unsigned int index)

public int GetPropertyNameLength(int index)

Parameters

index int

Returns

int

GetRectFValue(int)

Gets the value of the specified property by index.

public RectF GetRectFValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

RectF

The value of the specified property by index.

GetRectFValueByName(string)

Gets the value of the specified property by name.

public RectF GetRectFValueByName(string name)

Parameters

name string

The name of the property.

Returns

RectF

The value of the specified property by name.

GetSubProperties(int)

HRESULT ID2D1Properties::GetSubProperties([In] unsigned int index,[Out, Optional] ID2D1Properties** subProperties)

public Properties GetSubProperties(int index)

Parameters

index int

Returns

Properties

GetTypeInfo(int)

D2D1_PROPERTY_TYPE ID2D1Properties::GetType([In] unsigned int index)

public PropertyType GetTypeInfo(int index)

Parameters

index int

Returns

PropertyType

GetUIntValue(int)

Gets the value of the specified property by index.

[CLSCompliant(false)]
public uint GetUIntValue(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

uint

The value of the specified property by index.

GetUIntValueByName(string)

Gets the value of the specified property by name.

[CLSCompliant(false)]
public uint GetUIntValueByName(string name)

Parameters

name string

The name of the property.

Returns

uint

The value of the specified property by name.

GetValue(int, PropertyType, IntPtr, int)

HRESULT ID2D1Properties::GetValue([In] unsigned int index,[In] D2D1_PROPERTY_TYPE type,[Out, Buffer] void* data,[In] unsigned int dataSize)

public void GetValue(int index, PropertyType type, IntPtr data, int dataSize)

Parameters

index int

type PropertyType

data System.IntPtr

dataSize int

GetValue<T>(int, PropertyType)

Gets the value of the specified property by index.

public T GetValue<T>(int index, PropertyType type) where T : struct

Parameters

index int

The index of the property from which the data is to be obtained.

type PropertyType

Property type.

Returns

T

The value of the specified property by index.

Type Parameters

T

GetValue<T>(string, PropertyType)

Gets the value of the specified property by name.

public T GetValue<T>(string name, PropertyType type) where T : struct

Parameters

name string

The name of the property.

type PropertyType

Property type.

Returns

T

The value of the specified property by name.

Type Parameters

T

GetValueByName(string, PropertyType, IntPtr, int)

HRESULT ID2D1Properties::GetValueByName([In] const wchar_t* name,[In] D2D1_PROPERTY_TYPE type,[Out, Buffer] void* data,[In] unsigned int dataSize)

public void GetValueByName(string name, PropertyType type, IntPtr data, int dataSize)

Parameters

name string

type PropertyType

data System.IntPtr

dataSize int

GetValueSize(int)

unsigned int ID2D1Properties::GetValueSize([In] unsigned int index)

public int GetValueSize(int index)

Parameters

index int

Returns

int

GetVector2Value(int)

Gets the value of the specified property by index.

public Vector2 GetVector2Value(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

Vector2

The value of the specified property by index.

GetVector2ValueByName(string)

Gets the value of the specified property by name.

public Vector2 GetVector2ValueByName(string name)

Parameters

name string

The name of the property.

Returns

Vector2

The value of the specified property by name.

GetVector3Value(int)

Gets the value of the specified property by index.

public Vector3 GetVector3Value(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

Vector3

The value of the specified property by index.

GetVector3ValueByName(string)

Gets the value of the specified property by name.

public Vector3 GetVector3ValueByName(string name)

Parameters

name string

The name of the property.

Returns

Vector3

The value of the specified property by name.

GetVector4Value(int)

Gets the value of the specified property by index.

public Vector4 GetVector4Value(int index)

Parameters

index int

The index of the property from which the data is to be obtained.

Returns

Vector4

The value of the specified property by index.

GetVector4ValueByName(string)

Gets the value of the specified property by name.

public Vector4 GetVector4ValueByName(string name)

Parameters

name string

The name of the property.

Returns

Vector4

The value of the specified property by name.

SetEnumValue<T>(int, T)

Sets the named property to the given value.

public void SetEnumValue<T>(int index, T value) where T : struct

Parameters

index int

Index of the property

value T

Value of the property

Type Parameters

T

SetValue(int, ColorF)

Sets the named property to the given value.

public void SetValue(int index, ColorF value)

Parameters

index int

Index of the property

value ColorF

Value of the property

SetValue(int, PropertyType, IntPtr, int)

HRESULT ID2D1Properties::SetValue([In] unsigned int index,[In] D2D1_PROPERTY_TYPE type,[In, Buffer] const void* data,[In] unsigned int dataSize)

public void SetValue(int index, PropertyType type, IntPtr data, int dataSize)

Parameters

index int

type PropertyType

data System.IntPtr

dataSize int

SetValue(int, Matrix3x2)

Sets the named property to the given value.

public void SetValue(int index, Matrix3x2 value)

Parameters

index int

Index of the property

value Matrix3x2

Value of the property

SetValue(int, Matrix4x4)

Sets the named property to the given value.

public void SetValue(int index, Matrix4x4 value)

Parameters

index int

Index of the property

value Matrix4x4

Value of the property

SetValue(int, Matrix5x4)

Sets the named property to the given value.

public void SetValue(int index, Matrix5x4 value)

Parameters

index int

Index of the property

value Matrix5x4

Value of the property

SetValue(int, Point2F)

Sets the named property to the given value.

public void SetValue(int index, Point2F value)

Parameters

index int

Index of the property

value Point2F

Value of the property

SetValue(int, RectF)

Sets the named property to the given value.

public void SetValue(int index, RectF value)

Parameters

index int

Index of the property

value RectF

Value of the property

SetValue(int, Vector2)

Sets the named property to the given value.

public void SetValue(int index, Vector2 value)

Parameters

index int

Index of the property

value Vector2

Value of the property

SetValue(int, Vector3)

Sets the named property to the given value.

public void SetValue(int index, Vector3 value)

Parameters

index int

Index of the property

value Vector3

Value of the property

SetValue(int, Vector4)

Sets the named property to the given value.

public void SetValue(int index, Vector4 value)

Parameters

index int

Index of the property

value Vector4

Value of the property

SetValue(int, bool)

Sets the named property to the given value.

public void SetValue(int index, bool value)

Parameters

index int

Index of the property

value bool

Value of the property

SetValue(int, Guid)

Sets the named property to the given value.

public void SetValue(int index, Guid value)

Parameters

index int

Index of the property

value System.Guid

Value of the property

SetValue(int, int)

Sets the named property to the given value.

public void SetValue(int index, int value)

Parameters

index int

Index of the property

value int

Value of the property

SetValue(int, float)

Sets the named property to the given value.

public void SetValue(int index, float value)

Parameters

index int

Index of the property

value float

Value of the property

SetValue(int, string)

Sets the named property to the given value.

public void SetValue(int index, string value)

Parameters

index int

Index of the property

value string

Value of the property

SetValue(int, uint)

Sets the named property to the given value.

[CLSCompliant(false)]
public void SetValue(int index, uint value)

Parameters

index int

Index of the property

value uint

Value of the property

SetValue<T>(int, T)

Sets the named property to the given value.

public void SetValue<T>(int index, T value) where T : ComObject

Parameters

index int

Index of the property

value T

Value of the property

Type Parameters

T

SetValue<T>(int, PropertyType, T)

Sets the named property to the given value.

public void SetValue<T>(int index, PropertyType type, T value) where T : struct

Parameters

index int

Index of the property

type PropertyType

Property type.

value T

Value of the property

Type Parameters

T

SetValueByName(string, ColorF)

Sets the named property to the given value.

public void SetValueByName(string name, ColorF value)

Parameters

name string

Name of the property

value ColorF

Value of the property

SetValueByName(string, PropertyType, IntPtr, int)

HRESULT ID2D1Properties::SetValueByName([In] const wchar_t* name,[In] D2D1_PROPERTY_TYPE type,[In, Buffer] const void* data,[In] unsigned int dataSize)

public void SetValueByName(string name, PropertyType type, IntPtr data, int dataSize)

Parameters

name string

type PropertyType

data System.IntPtr

dataSize int

SetValueByName(string, Matrix3x2)

Sets the named property to the given value.

public void SetValueByName(string name, Matrix3x2 value)

Parameters

name string

Name of the property

value Matrix3x2

Value of the property

SetValueByName(string, Matrix4x4)

Sets the named property to the given value.

public void SetValueByName(string name, Matrix4x4 value)

Parameters

name string

Name of the property

value Matrix4x4

Value of the property

SetValueByName(string, Matrix5x4)

Sets the named property to the given value.

public void SetValueByName(string name, Matrix5x4 value)

Parameters

name string

Name of the property

value Matrix5x4

Value of the property

SetValueByName(string, Point2F)

Sets the named property to the given value.

public void SetValueByName(string name, Point2F value)

Parameters

name string

Name of the property

value Point2F

Value of the property

SetValueByName(string, RectF)

Sets the named property to the given value.

public void SetValueByName(string name, RectF value)

Parameters

name string

Name of the property

value RectF

Value of the property

SetValueByName(string, Vector2)

Sets the named property to the given value.

public void SetValueByName(string name, Vector2 value)

Parameters

name string

Name of the property

value Vector2

Value of the property

SetValueByName(string, Vector3)

Sets the named property to the given value.

public void SetValueByName(string name, Vector3 value)

Parameters

name string

Name of the property

value Vector3

Value of the property

SetValueByName(string, Vector4)

Sets the named property to the given value.

public void SetValueByName(string name, Vector4 value)

Parameters

name string

Name of the property

value Vector4

Value of the property

SetValueByName(string, bool)

Sets the named property to the given value.

public void SetValueByName(string name, bool value)

Parameters

name string

Name of the property

value bool

Value of the property

SetValueByName(string, Guid)

Sets the named property to the given value.

public void SetValueByName(string name, Guid value)

Parameters

name string

Name of the property

value System.Guid

Value of the property

SetValueByName(string, int)

Sets the named property to the given value.

public void SetValueByName(string name, int value)

Parameters

name string

Name of the property

value int

Value of the property

SetValueByName(string, float)

Sets the named property to the given value.

public void SetValueByName(string name, float value)

Parameters

name string

Name of the property

value float

Value of the property

SetValueByName(string, string)

Sets the named property to the given value.

public void SetValueByName(string name, string value)

Parameters

name string

Name of the property

value string

Value of the property

SetValueByName(string, uint)

Sets the named property to the given value.

[CLSCompliant(false)]
public void SetValueByName(string name, uint value)

Parameters

name string

Name of the property

value uint

Value of the property

SetValueByName<T>(string, T)

Sets the named property to the given value.

public void SetValueByName<T>(string name, T value) where T : ComObject

Parameters

name string

Name of the property

value T

Value of the property

Type Parameters

T

SetValueByName<T>(string, PropertyType, T)

Sets the named property to the given value.

public void SetValueByName<T>(string name, PropertyType type, T value) where T : struct

Parameters

name string

Name of the property

type PropertyType

Property type.

value T

Value of the property

Type Parameters

T

Operators

explicit operator Properties(IntPtr)

Performs an explicit conversion from System.IntPtr to Properties.

public static explicit operator Properties(IntPtr nativePointer)

Parameters

nativePointer System.IntPtr

Returns

Properties