Click or drag to resize

GraphDocument Class

[Missing <summary> documentation for "T:Altaxo.Graph.Graph3D.GraphDocument"]

Inheritance Hierarchy

Namespace: Altaxo.Graph.Graph3D
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public class GraphDocument : GraphDocumentBase

The GraphDocument type exposes the following members.

Constructors
 NameDescription
Public methodGraphDocument Creates a empty GraphDocument with no layers and a standard size of A4 landscape.
Public methodGraphDocument(GraphDocument)Initializes a new instance of the GraphDocument class
Top
Properties
 NameDescription
Protected propertyAccumulatedEventData Gets the accumulated event data.
(Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
Public propertyCamera 
Public propertyCreationTimeUtc The date/time of creation of this graph.
(Inherited from GraphDocumentBase)
Protected propertyDebug_AbsolutePath Gets the absolute path of the node for debugging purposes.
(Inherited from SuspendableDocumentNodeBase)
Public propertyIsDisposed Gets a value indicating whether this instance is disposed.
(Inherited from SuspendableDocumentNodeBase)
Public propertyIsDisposeInProgress Gets a value indicating whether for this instance dispose is in progress, or the instance is already disposed.
(Inherited from SuspendableDocumentNodeBase)
Public propertyIsResumeInProgress Gets a value indicating whether this instance is currently resuming the events.
(Inherited from SuspendableDocumentNode)
Public propertyIsSomeoneListeningToChanges Gets a value indicating whether someone is listening to changes. For this, either the ParentObject or the Changed event must be set.
(Inherited from SuspendableDocumentNodeBase)
Public propertyIsSuspended Gets a value indicating whether this instance is suspended.
(Inherited from SuspendableDocumentNode)
Public propertyIsSuspendedOrResumeInProgress Gets a value indicating whether this instance is suspended or resume is currently in progress.
(Inherited from SuspendableDocumentNode)
Public propertyLastChangeTimeUtc The date/time when this graph was changed.
(Inherited from GraphDocumentBase)
Public propertyLighting 
Public propertyName
(Inherited from GraphDocumentBase)
Public propertyNotes Notes concerning this graph.
(Inherited from GraphDocumentBase)
Public propertyParentObject Get / sets the parent object of this table.
(Inherited from GraphDocumentBase)
Public propertyPropertyBag
(Inherited from GraphDocumentBase)
Public propertyPropertyBagNotNull
(Inherited from GraphDocumentBase)
Public propertyRootLayer The collection of layers of the graph.
Public propertySize Gets/sets the size of this graph in points (1/72 inch). The value returned is exactly the size of the root layer.
(Overrides GraphDocumentBaseSize)
Top
Methods
 NameDescription
Protected methodAccumulateChangeData
(Inherited from GraphDocumentBase)
Protected methodAccumulatedChangeData_SetBackAfterResumeAndSuspend Sets the change data without further processing. This function is infrastructure and intended to use only in OnResume after the parent has suspended this node again.
(Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
Protected methodAccumulatedEventData_Clear Clears the accumulated event data.
(Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
Protected methodAccumulatedEventData_HasZeroOrOneEventArg Determines whether there is no or only one single event arg accumulated. If this is the case, the return value is true. If there is one event arg accumulated, it is returned in the argument singleEventArg. The return value is false if there is more than one event arg accumulated. In this case the singleEventArg is null on return, and the calling function should use AccumulatedEventData to enumerate all accumulated event args.
(Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
Protected methodChildCloneFromT Clones a node that is intended to use as child node of this instance (e.g. in collections). Consider using ChildCloneToMemberT(T, T) instead if the child node is stored in a member of this instance.
(Inherited from SuspendableDocumentNode)
Protected methodChildCloneToMemberT Sets a member variable that holds a child with a cloned instance of another variable. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then cloned using System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship.
(Inherited from SuspendableDocumentNode)
Protected methodChildCloneToMemberAltT Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. The value to set may or may not implement ICloneable. If it implements ICloneable, then the member variable is set to a clone of the value. Otherwise, the member variable is set directly with the value. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed.
(Inherited from SuspendableDocumentNode)
Protected methodChildCopyToMemberT Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. The node is then copied using either Main.ICopyFrom or System.ICloneable. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship.
(Inherited from SuspendableDocumentNode)
Protected methodChildCopyToMemberOrCreateNewT Copies a document node from another source into a member of this instance. If an old instance member (provided in myChild exists and can not be used, it is disposed first. If the node is not null, the node is then copied using either Main.ICopyFrom or System.ICloneable. If the node is null, a new node is created using the provided generation function. The resulting node's ParentObject is then set to this instance in order to maintain the parent-child relationship.
(Inherited from SuspendableDocumentNode)
Protected methodChildDisposeMemberT Helper function to dispose a child node of this instance. It helps to ensure the correct order: first, the child node is set to null and only then the child node is disposed.
(Inherited from SuspendableDocumentNodeBase)
Protected methodChildSetMemberT Set a member variable that holds a child node of this instance. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed.
(Inherited from SuspendableDocumentNode)
Protected methodChildSetMemberAltT Set a member variable that holds a child node of this instance. The child node may or may not implement IDocumentLeafNode. It helps to ensure the correct order: first, the child node is set to the new instance and then the old child node is disposed.
(Inherited from SuspendableDocumentNode)
Public methodClone
(Overrides GraphDocumentBaseClone)
Public methodCopyFrom 
Public methodCountEvent Counts the number of events during the suspend state. Every call to this function will increment the event counter by 1 (but only in the suspended state). The event counter will be reset to zero when the object is resumed.
(Inherited from SuspendableDocumentNode)
Public methodDispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SuspendableDocumentNodeBase)
Protected methodDispose(Boolean)
(Inherited from SuspendableDocumentNode)
Public methodEhChildChanged Used by childs of this object to inform us about a change in their state.
(Inherited from SuspendableDocumentNode)
Public methodEhParentTunnelingEventHappened Is called by the parent when a tunneling event happened in the parent.
(Inherited from SuspendableDocumentNode)
Protected methodEhSelfChanged Called if some (simple) member or property of this instance itself has changed.
(Inherited from SuspendableDocumentNode)
Public methodEhSelfTunnelingEventHappened(TunnelingEventArgs) Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is additionally distributed to all childs of this instance.
(Inherited from SuspendableDocumentNodeBase)
Public methodEhSelfTunnelingEventHappened(TunnelingEventArgs, Boolean) Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is - depending on the provided parameter - also distributed to all childs of this instance.
(Inherited from SuspendableDocumentNode)
Public methodEnumerateFromHereToLeaves Enumerates all document node including this node, its child nodes, its child-child nodes up to the leaf nodes.
(Inherited from SuspendableDocumentNode)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Finalizes an instance of the SuspendableDocumentNodeBase class.
(Inherited from SuspendableDocumentNodeBase)
Public methodGetChildObjectNamed Retrieves the child node of this instance with the name
C#
name
.
(Inherited from SuspendableDocumentNode)
Public methodStatic memberGetDefaultBackColor 
Public methodStatic memberGetDefaultFont 
Public methodStatic memberGetDefaultForeColor 
Public methodStatic memberGetDefaultMajorTickLength Gets the default major tick length for all graphics in this graph, using the provided property context.
Public methodStatic memberGetDefaultPenWidth Gets the default width of the pen for all graphics in this graph, using the provided property context.
Public methodStatic memberGetDefaultPlotColor 
Public methodStatic memberGetDefaultSymbolSize Gets the default plot symbol size for all graphics in this graph, using the provided property context.
Protected methodGetDocumentNodeChildrenWithName
(Overrides SuspendableDocumentNodeGetDocumentNodeChildrenWithName)
Public methodGetFirstLayerOfTypeTLayer Gets the first layer in the graph that has the provided type. If such a layer is not found, an exception is thrown.
Public methodGetFirstXYPlotLayer Gets the first xy plot layer of the graph. If such a layer is not found, an exception is thrown.
Public methodGetGraphProperty Gets an arbitrary object that was stored as graph property by SetGraphProperty(String, Object).
(Inherited from GraphDocumentBase)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetNameOfChildObject Gets the name of child node.
(Inherited from SuspendableDocumentNode)
Public methodGetPropertyValueT
(Inherited from GraphDocumentBase)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodHandleHighPriorityChildChangeCases
(Inherited from GraphDocumentBase)
Protected methodHandleLowPriorityChildChangeCases Processes the event args e when this object is not suspended. This function serves two purposes: i) updating some cached data of this object by processing the event args of the child, and ii) optional transforming the event args, for instance to a new type, which afterwards is send to the parent and is used as event args in the [E:Changed] event of this object. The transformed event args is not used if this object is suspended (in this case the original event args is used).
(Inherited from SuspendableDocumentNode)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodNotifyChildrenTunnelingEventHappened Notifies the child nodes of this instance that a tunneling event has happened.
(Inherited from SuspendableDocumentNode)
Protected methodOnAboutToBeResumed Is called when the suspend level is still 1 (one), but is about to fall to zero, i.e. shortly before the call to OnResume(Int32). This function is not called before OnResumeSilently(Int32)!
(Inherited from SuspendableDocumentNode)
Protected methodOnChanged
(Overrides SuspendableDocumentNodeBaseOnChanged(EventArgs))
Protected methodOnInvalidate Fires the Invalidate event.
Protected methodOnNameChanged Fires both a Changed and a TunnelingEvent when the name has changed. The event arg of the Changed event is an instance of NamedObjectCollectionChangedEventArgs. The event arg of the Tunneling event is an instance of DocumentPathChangedEventArgs.
(Inherited from GraphDocumentBase)
Protected methodOnResume Is called when the object is resumed, i.e. change notifications are allowed again. During the execution of this function, the [P:IsResumeInProgress] property will return true to indicate that the resume is currently in progress.
(Inherited from SuspendableDocumentNode)
Protected methodOnResumeSilently Is called when the suspend level falls down from 1 to zero by a call to ResumeSilently. This implementation disarma the suspendTokens of the childs of this object, deletes any accumulated events, and does not send any change event to the parent or the listeners of the Change event.
(Inherited from SuspendableDocumentNode)
Protected methodOnSizeChanged Fires the SizeChanged event.
(Inherited from GraphDocumentBase)
Protected methodOnSuspended Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended.
(Inherited from SuspendableDocumentNode)
Protected methodOnTunnelingEvent Fires the TunneledEvent event.
(Inherited from SuspendableDocumentNodeBase)
Public methodPaint 
Public methodResume(ISuspendToken) Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. If Event data were accumulated during the suspended state, a changed event is triggered for each event data.
(Inherited from SuspendableDocumentNodeBase)
Public methodResume(ISuspendToken, EventFiring) Resumes changed events, either with taking the accumulated event data into account (see Resume(ISuspendToken)) or discarding the accumulated event data (see ResumeSilently(ISuspendToken), depending on the provided argument eventFiring.
(Inherited from SuspendableDocumentNodeBase)
Public methodResumeCompleteTemporarily Resumes the object completely for only a short time. Thus, if object was suspended before, it will be suspended again when the function returns.
(Inherited from SuspendableDocumentNode)
Public methodResumeCompleteTemporarilyGetToken Resumes the object completely for the time the returned token is referenced and not disposed. The return value is a token that had 'absorbed' the suspend count of the object, resulting in the suspend count of the object dropped to 0 (zero). When the returned token is finally disposed, the suspend count of the object is increased again by the 'absorbed' suspend count.
(Inherited from SuspendableDocumentNode)
Public methodResumeSilently Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. All event data accumulated during the suspended state are discarded, and thus no change event is triggered even if the instance has changed during the suspended state.
(Inherited from SuspendableDocumentNodeBase)
Public methodSetDisposeInProgress Sets the flag that dispose is in progress for this node and all child nodes recursively.
(Inherited from SuspendableDocumentNode)
Public methodSetGraphProperty The table properties, key is a string, val is a object you want to store here.
(Inherited from GraphDocumentBase)
Protected methodSetMemberAndRaiseSelfChangedT(NullableT, NullableT) Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions.
(Inherited from SuspendableDocumentNodeBase)
Protected methodSetMemberAndRaiseSelfChangedT(T, T) Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions.
(Inherited from SuspendableDocumentNodeBase)
Protected methodSetMemberEnumAndRaiseSelfChangedT Sets a member variable (which is an Enum) of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions.
(Inherited from SuspendableDocumentNodeBase)
Public methodSuspendGetToken Suspend will increase the SuspendLevel.
(Inherited from SuspendableDocumentNode)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryGetName Tests if this item already has a name.
(Inherited from GraphDocumentBase)
Public methodViewToRootLayerCenter Make the views to look at the root layer center. The scale is choosen so that the size of the plot will be maximal.
Public methodVisitDocumentReferences Replaces path of items (intended for data items like tables and columns) by other paths. Thus it is possible to change a plot so that the plot items refer to another table.
(Overrides GraphDocumentBaseVisitDocumentReferences(DocNodeProxyReporter))
Top
Events
 NameDescription
Public eventChangedFired when something in the object has changed, and the object is not suspended.
(Inherited from SuspendableDocumentNodeBase)
Public eventSizeChangedEvent fired if the size of this document (i.e. the size of the root layer) changed.
(Inherited from GraphDocumentBase)
Public eventTunneledEvent The event that is fired when the object is disposed. First argument is the sender, second argument is the original source, and third argument is the event arg.
(Inherited from SuspendableDocumentNodeBase)
Top
Fields
 NameDescription
Protected field_accumulatedEventData Holds the accumulated change data.
(Inherited from SuspendableDocumentNodeWithSingleAccumulatedDataT)
Protected field_creationTime The date/time of creation of this graph.
(Inherited from GraphDocumentBase)
Protected field_graphIdentifier An identifier that can be shown on the graph and that is searchable.
(Inherited from GraphDocumentBase)
Protected field_graphProperties The graph properties, key is a string, value is a property (arbitrary object) you want to store here.
(Inherited from GraphDocumentBase)
Protected field_hasFixupChangedAnythingThis flag is set if during fixup anything has changed.
(Inherited from GraphDocumentBase)
Protected field_isFixupInternalDataStructuresActive
(Inherited from GraphDocumentBase)
Protected field_lastChangeTime The date/time when this graph was changed.
(Inherited from GraphDocumentBase)
Protected field_name The name of the graph.
(Inherited from GraphDocumentBase)
Protected field_notes Notes concerning this graph.
(Inherited from GraphDocumentBase)
Protected field_paintThreadEvents which are fired from this thread are not distributed.
(Inherited from GraphDocumentBase)
Protected field_parent The parent object this instance belongs to.
(Inherited from SuspendableDocumentNodeBase)
Protected field_suspendTokensOfChildsStores the suspend tokens of the suspended childs of this object.
(Inherited from SuspendableDocumentNode)
Protected fieldStatic memberDefaultRootLayerSizeX 
Protected fieldStatic memberDefaultRootLayerSizeY 
Protected fieldStatic memberDefaultRootLayerSizeZ 
Public fieldStatic memberPropertyKeyDefaultFont 
Public fieldStatic memberPropertyKeyDefaultForeColor 
Public fieldStatic memberPropertyKeyDefaultRootLayerSize 
Public fieldStatic memberPropertyKeyDefaultSceneBackColor 
Public fieldStatic memberPropertyKeyRootLayerMarkersVisibility 
Top
Extension Methods
 NameDescription
Public Extension MethodCopyToClipboardAsBitmap Copies the current graph as an bitmap image to the clipboard in native bmp format.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodCopyToClipboardAsNative Puts the entire graph to the clipboard in XML format.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodCopyToClipboardLayerAsNative Puts the layer with index layerNumber to the clipboard in XML format.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodDeleteLayer Deletes the layer specified by index layerNumber.
(Defined by GraphDocumentOtherActions)
Public Extension MethodMoveLayerToPosition Moves the layer specified by index sourcePosition to index destposition.
(Defined by GraphDocumentOtherActions)
Public Extension MethodOnUserRescaledAxes This command will rescale all axes in all layers
(Defined by GraphDocumentOtherActions)
Public Extension MethodPasteFromClipboard Try to paste the entire GraphDocument from the clipboard using the specified paste options.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodPasteFromClipboardAsGraphStyle Try to paste the entire GraphDocument from the clipboard.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodPasteFromClipboardAsNewChildLayerOfLayerNumber Pastes a layer on the clipboard as new layer after the layer at index currentActiveLayerNumber.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodPasteFromClipboardAsNewLayer
(Defined by GraphDocumentClipboardActions)
Public Extension MethodPasteFromClipboardAsNewLayerAfterLayerNumber Pastes a layer on the clipboard as new layer after the layer at index currentActiveLayerNumber.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodPasteFromClipboardAsNewLayerBeforeLayerNumber Pastes a layer on the clipboard as new layer before the layer specified by index currentActiveLayerNumber.
(Defined by GraphDocumentClipboardActions)
Public Extension MethodPasteFromClipboardAsTemplateForLayer
(Defined by GraphDocumentClipboardActions)
Public Extension MethodRenderAsBitmap
(Defined by GraphDocumentExportActions)
Public Extension MethodRenderAsBitmap Saves the graph as an bitmap file and returns the bitmap.
(Defined by GraphDocumentExportActions)
Public Extension MethodRenderAsBitmap Saves the graph as an bitmap file and returns the bitmap.
(Defined by GraphDocumentExportActions)
Public Extension MethodRenderToStream Saves the graph as into a stream.
(Defined by GraphDocumentExportActions)
Public Extension MethodRenderToStream Saves the graph into a stream.
(Defined by GraphDocumentExportActions)
Public Extension MethodShowCopyPageOptionsDialog Shows the copy page options dialog and stores the result as the static field CopyPageOptions here in this class
(Defined by GraphDocumentClipboardActions)
Public Extension MethodShowFileExportDialog
(Defined by GraphDocumentBaseExportActions)
Public Extension MethodShowFileExportSpecificDialog
(Defined by GraphDocumentBaseExportActions)
Public Extension MethodShowLayerDialog
(Defined by GraphDocumentOtherActions)
Public Extension MethodShowMoveLayerToPositionDialog Moves the layer specified by index layerNumber as specified by the user in the opened dialog.
(Defined by GraphDocumentOtherActions)
Public Extension MethodShowPropertyDialog
(Defined by GraphDocumentOtherActions)
Public Extension MethodShowRenameDialog
(Defined by GraphDocumentOtherActions)
Top
See Also