Class Component

Namespace

SharpDX.Toolkit

Assembly

HelixToolkit.SharpDX.dll

A disposable component base class.

public abstract class Component : ComponentBase, IComponent, INotifyPropertyChanged, IDisposable

Inheritance

object

ComponentBase

Component

Implements

IComponent

INotifyPropertyChanged

IDisposable

Derived

GraphicsResource

Image

Inherited Members

ComponentBase.Name

ComponentBase.Tag

ComponentBase.PropertyChanged

ComponentBase.OnPropertyChanged(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Component()

Initializes a new instance of the Component class.

protected Component()

Component(string?)

Initializes a new instance of the Component class with an immutable name.

protected Component(string? name)

Parameters

name string

The name.

Properties

DisposeCollector

Gets or sets the disposables.

protected DisposeCollector? DisposeCollector { get; set; }

Property Value

DisposeCollector

The disposables.

IsDisposed

Gets a value indicating whether this instance is disposed.

protected bool IsDisposed { get; }

Property Value

bool

true if this instance is disposed; otherwise, false.

IsDisposing

protected bool IsDisposing { get; }

Property Value

bool

Methods

Dispose()

Releases unmanaged and - optionally - managed resources

[SuppressMessage("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly", Justification = "False positive.")]
public void Dispose()

Dispose(bool)

Disposes of object resources.

protected virtual void Dispose(bool disposeManagedResources)

Parameters

disposeManagedResources bool

If true, managed resources should be disposed of in addition to unmanaged resources.

RemoveAndDispose<T>(ref T)

Dispose a disposable object and set the reference to null. Removes this object from the ToDispose list.

protected void RemoveAndDispose<T>(ref T objectToDispose)

Parameters

objectToDispose T

Object to dispose.

Type Parameters

T

RemoveToDispose<T>(T)

Removes a disposable object to the list of the objects to dispose.

protected void RemoveToDispose<T>(T toDisposeArg)

Parameters

toDisposeArg T

To dispose.

Type Parameters

T

ToDispose<T>(T)

Adds a disposable object to the list of the objects to dispose.

protected T? ToDispose<T>(T toDisposeArg)

Parameters

toDisposeArg T

To dispose.

Returns

T

Type Parameters

T

Events

Disposing

Occurs when when Dispose is called.

public event EventHandler<EventArgs>? Disposing

Event Type

EventHandler<EventArgs>