IBackground |
Background for some items, mainly intended for text.
Namespace: Altaxo.Graph.Graph3D.Background
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
public interface IBackgroundStyle : IDocumentLeafNode, INamedObject, IChangedEventSource, ISuspendableByToken, ITunnelingEventSource, IDisposable, ITreeNodeWithParent<IDocumentLeafNode>, ITreeNode<IDocumentLeafNode>, INodeWithParentNode<IDocumentLeafNode>, ICloneable
The IBackgroundStyle type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ChildNodes |
Gets the child nodes.
(Inherited from ITreeNodeT) |
| Distance | Gets or sets the user defined distance. If this value is null, the background class has to find an appropriate distance in the Measure(RectangleD3D) step by itself. |
| IsDisposed |
Gets a value indicating whether this instance is disposed.
(Inherited from IDocumentLeafNode) |
| IsDisposeInProgress |
Gets a value indicating whether this instance is in dispose progress, or the instance is already disposed.
(Inherited from IDocumentLeafNode) |
| IsSuspended |
Gets a value indicating whether this instance is suspended.
(Inherited from ISuspendableByToken) |
| Material | Gets or sets the material used to draw the background. |
| Name |
Gets the name of this instance.
An InvalidOperationException will be thrown if the name is not yet set or can not be retrieved.
(Inherited from INamedObject) |
| ParentNode |
Gets the parent node of this node.
(Inherited from INodeWithParentNodeT) |
| ParentObject |
Gets or sets the parent document node of this leaf node.
(Inherited from IDocumentLeafNode) |
| SupportsUserDefinedMaterial | Gets or sets a value indicating whether this background supports user defined material. For some background classes, the kind of material may be fixed, for instance a black background. In this case the value is false. For other backgrounds, you are free to chose the material, in this case the value is true. |
| Thickness | Gets or sets the user defined background thickness. If this value is null, the background class has to find an appropriate thickness in the Measure(RectangleD3D) step by itself. |
Methods| Name | Description | |
|---|---|---|
 | Clone | Creates a new object that is a copy of the current instance. (Inherited from ICloneable) |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable) |
| Draw(IGraphicsContext3D, RectangleD3D) | Draws the specified background. |
| Draw(IGraphicsContext3D, RectangleD3D, IMaterial) | Draws the specified background. |
| EhParentTunnelingEventHappened |
Handles a tunneling event raised by a parent document node.
(Inherited from IDocumentLeafNode) |
| Measure | Measures the background size and position. |
| SetDisposeInProgress |
Sets the flag that dispose is in progress for this node and all child nodes recursively.
(Inherited from IDocumentLeafNode) |
| SuspendGetToken |
Suspends the event handling of the object by getting a suspend token. The event handling of the object is resumed when the suspend token is disposed.
(Inherited from ISuspendableByToken) |
| TryGetName |
Test if this item already has a name.
(Inherited from INamedObject) |
Events| Name | Description | |
|---|---|---|
 | Changed | Fired when something in the object has changed. (Inherited from IChangedEventSource) |
| TunneledEvent |
The event that is fired when a tunneling event occurs.
First argument is the sender,
second argument is the original source,
and third argument is the event arguments.
(Inherited from ITunnelingEventSource) |
Extension Methods| Name | Description | |
|---|---|---|
 | GetPropertyContext |
Gets the property context of the document node. If the provided node is not implementing IPropertyBagOwner, the parent nodes of this node are searched,
until a node which implements IPropertyBagOwner is found.
(Defined by PropertyExtensions) |
See Also