Click or drag to resize

IPlotGroupStyle Interface

Represents plotting properties that can be grouped together, for instance color or line style.

Namespace: Altaxo.Graph.Plot.Groups
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
Copy
public interface IPlotGroupStyle : IDocumentLeafNode, 
	INamedObject, IChangedEventSource, ISuspendableByToken, ITunnelingEventSource, IDisposable, 
	ITreeNodeWithParent<IDocumentLeafNode>, ITreeNode<IDocumentLeafNode>, INodeWithParentNode<IDocumentLeafNode>, 
	ICloneable

The IPlotGroupStyle type exposes the following members.

Properties
 NameDescription
Public propertyCanCarryOver Determines whether this style can carry over during the Step(Int32) operation. If yes, then the style can have children, i.e. other plot group styles that are incremented if this group style carries over. When Step(Int32) can return a nonzero value, true is returned here. For instance, color or line style can be stepped and can carry over, so they return true here. In contrast, a bar graph group style can be stepped, but it cannot carry over, so false is returned here.
Public propertyCanStep Indicates whether this group style makes any action when calling Step(Int32). This property is true, if IsStepEnabled can be set to true.
Public propertyChildNodes Gets the child nodes.
(Inherited from ITreeNodeT)
Public propertyIsDisposed Gets a value indicating whether this instance is disposed.
(Inherited from IDocumentLeafNode)
Public propertyIsDisposeInProgress Gets a value indicating whether this instance is in dispose progress, or the instance is already disposed.
(Inherited from IDocumentLeafNode)
Public propertyIsInitialized Returns true when this group style contains valid grouping data. You should set IsInitialized to false when BeginPrepare is called.
Public propertyIsStepEnabled Gets or sets whether stepping is allowed.
Public propertyIsSuspended Gets a value indicating whether this instance is suspended.
(Inherited from ISuspendableByToken)
Public propertyName 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)
Public propertyParentNode Gets the parent node of this node.
(Inherited from INodeWithParentNodeT)
Public propertyParentObject Gets or sets the parent document node of this leaf node.
(Inherited from IDocumentLeafNode)
Top
Methods
 NameDescription
Public methodBeginPrepare Called at the beginning of the preparation.
Public methodCloneCreates a new object that is a copy of the current instance.
(Inherited from ICloneable)
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodEhParentTunnelingEventHappened Handles a tunneling event raised by a parent document node.
(Inherited from IDocumentLeafNode)
Public methodEndPrepare Called at the end of the preparation.
Public methodPrepareStep Prepares the next step after each plot item has been prepared.
Public methodSetDisposeInProgress Sets the flag that dispose is in progress for this node and all child nodes recursively.
(Inherited from IDocumentLeafNode)
Public methodStep Increments/decrements the style. Returns +1 or -1 when the style was swapped around.
Public methodSuspendGetToken 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)
Public methodTransferFrom Transfers the core properties (but not the adminstrative properties like isStepEnabled) from another instance to this instance.
Public methodTryGetName Test if this item already has a name.
(Inherited from INamedObject)
Top
Events
 NameDescription
Public eventChangedFired when something in the object has changed.
(Inherited from IChangedEventSource)
Public eventTunneledEvent 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)
Top
Extension Methods
 NameDescription
Public Extension MethodGetPropertyContext 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)
Top
See Also