Host |
The HostLayer type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AccumulateChangeData | (Inherited from SuspendableDocumentNodeWithSetOfEventArgs) |
| AccumulatedChangeData_SetBackAfterResumeAndSuspend | (Inherited from SuspendableDocumentNodeWithSetOfEventArgs) |
| AccumulatedEventData_Clear |
Clears the accumulated event data.
(Inherited from SuspendableDocumentNodeWithSetOfEventArgs) |
| AccumulatedEventData_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 SuspendableDocumentNodeWithSetOfEventArgs) |
| CalculateCachedSizeAndPosition | Sets the cached size value in _cachedLayerSize by calculating it from the position values (_location.Width and .Height) and the size types (_location.WidthType and .HeightType). |
| CalculateMatrix | |
 | CanCreateGridForLocation | Determines whether this layer is able to create a grid, so that a child layer with a given location fits into a grid cell. |
| ChildCloneFromT |
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) |
| ChildCloneToMemberT |
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) |
| ChildCloneToMemberAltT |
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) |
| ChildCopyToMemberT |
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) |
| ChildCopyToMemberOrCreateNewT |
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) |
| ChildDisposeMemberT |
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) |
| ChildSetMemberT |
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) |
| ChildSetMemberAltT |
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) |
| Clone | |
| CopyFrom(Object) | |
| CopyFrom(HostLayer, GraphCopyOptions) | |
| CountEvent |
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) |
| CreateDefaultGrid | Creates the default grid. It consists of three rows and three columns. Columns 0 and 2 are the left and right margin, respectively. Rows 0 and 2 are the top and bottom margin. The cell column 1 / row 1 is intended to hold the child layer. |
| CreateGridForLocation | Creates the grid, so that a child layer with the location given by the argument itemLocation fits into the grid at the same position as before. You should check with CanCreateGridForLocation(ItemLocationDirect) whether it is possible to create a grid for the given item location. |
| CreateGridIfNullOrEmpty | If the Grid is null, then create a grid that represents the boundaries of the child layers. |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from SuspendableDocumentNodeBase) |
| Dispose(Boolean) | (Overrides SuspendableDocumentNodeDispose(Boolean)) |
| EhChildChanged |
Used by childs of this object to inform us about a change in their state.
(Inherited from SuspendableDocumentNode) |
| EhParentTunnelingEventHappened |
Is called by the parent when a tunneling event happened in the parent.
(Inherited from SuspendableDocumentNode) |
| EhSelfChanged |
Called if some (simple) member or property of this instance itself has changed.
(Inherited from SuspendableDocumentNode) |
| EhSelfTunnelingEventHappened(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) |
| EhSelfTunnelingEventHappened(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) |
| EnumerateFromHereToLeaves |
Enumerates all document node including this node, its child nodes, its child-child nodes up to the leaf nodes.
(Inherited from SuspendableDocumentNode) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteFromTopmostChildToRoot | Executes an action on each child layer, including this layer, beginning with the topmost child (the first child of the first child of...). |
| Finalize |
Finalizes an instance of the SuspendableDocumentNodeBase class.
(Inherited from SuspendableDocumentNodeBase) |
| FixAndTestParentChildRelationShipOfLayers | |
| FixupInternalDataStructures | Adjusts the internal data structures to ensure its validity. |
| ForwardTransform | |
 | GetChildLayerDefaultLocation | |
| GetChildObjectNamed |
Retrieves the child node of this instance with the name C# name (Inherited from SuspendableDocumentNode) |
| GetDefaultNameOfLayer | Returns the document name of the layer at index i. Actually, this is a name of the form L0, L1, L2 and so on. |
| GetDocumentNodeChildrenWithName | (Overrides SuspendableDocumentNodeGetDocumentNodeChildrenWithName) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetNameOfChildObject |
Gets the name of child node.
(Inherited from SuspendableDocumentNode) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GraphToLayerCoordinates | |
| HandleHighPriorityChildChangeCases | (Overrides SuspendableDocumentNodeHandleHighPriorityChildChangeCases(Object, EventArgs)) |
| HandleLowPriorityChildChangeCases |
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) |
| HitTest(HitTestPointData) | |
| HitTest(HitTestRectangularData) | Hit test of retangular hit test data against the layer (here treated as IGraphicBase object). Decision is here not to allow the layer itself to be selected by rectangular selection, instead we allow all subobjects to be selected. |
| HitTest(HitTestPointData, Boolean) | |
| HitTest(HitTestRectangularData, ListIHitTestObject) | Collects all sub-objects of this layer that are selected by a rectangular selection area into a list. |
| InternalCopyFrom | Internal copy from operation. It is presumed, that the events are already suspended. Additionally, it is not neccessary to call the OnChanged event, since this is called in the calling routine. |
| InternalCopyGraphItems(HostLayer, GraphCopyOptions) | |
| InternalCopyGraphItems(HostLayer, GraphCopyOptions, FuncIGraphicBase, Boolean) | |
| IsCompatibleWithParent | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| NotifyChildrenTunnelingEventHappened |
Notifies the child nodes of this instance that a tunneling event has happened.
(Inherited from SuspendableDocumentNode) |
| OnAboutToBeResumed |
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) |
| OnCachedResultingPositionChanged | Called when the resulting position of this layer has changed. Is intended to inform child layers and own dependend objects of the position change. Because it is only the cached position, it will not raise changed events. Those events must be raised in the function that caused the change of the resulting position. |
| OnCachedResultingSizeChanged | Called when the resulting size of this layer has changed. Is intended to inform child layers and own dependend objects of the size change. Because it is only the cached size, it will not raise changed events. Those events must be raised in the function that caused the change of the resulting size. |
| OnChanged |
Fires the change event with the EventArgs provided in the argument.
(Inherited from SuspendableDocumentNodeBase) |
| OnGraphObjectsCollectionInstanceInitialized | Called after the instance of the GraphicCollectionGraphObjects has been initialized. |
| OnLayerNumberChanged | Is called by the parent layer if the index of this layer has changed. |
| OnResume |
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) |
| OnResumeSilently |
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) |
| OnSuspended |
Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended.
(Inherited from SuspendableDocumentNode) |
| OnTunnelingEvent |
Fires the TunneledEvent event.
(Inherited from SuspendableDocumentNodeBase) |
| Paint | |
| PaintInternal | Internal Paint routine. The graphics state saving and transform is already done here! |
| PaintPostprocessing | This function is called when painting is finished. Can be used to release the resources not neccessary any more. |
| PaintPreprocessing | This function is called by the graph document before _any_ layer is painted. We have to make sure that all of our cached data becomes valid. |
| PrependTransformationTo | Appends the transformation matrix of this instance to the matrix given in matrix. |
| Remove | |
| Resume(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) |
| Resume(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) |
| ResumeCompleteTemporarily |
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) |
| ResumeCompleteTemporarilyGetToken |
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) |
| ResumeSilently |
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) |
| SetDisposeInProgress |
Sets the flag that dispose is in progress for this node and all child nodes recursively.
(Inherited from SuspendableDocumentNode) |
| SetMemberAndRaiseSelfChangedT(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) |
| SetMemberAndRaiseSelfChangedT(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) |
| SetMemberEnumAndRaiseSelfChangedT |
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) |
| SetParentSize | |
| SetPositionSize | |
| SizeToDefault | Set this layer to the default size and position. |
| SuspendGetToken |
Suspend will increase the SuspendLevel.
(Inherited from SuspendableDocumentNode) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| TransformationFromRootToHere | |
| TransformCoordinateDifferencesFromParentToHere | Converts X,Y differences in page units to X,Y differences in layer units |
| TransformCoordinatesFromHereToParent(GraphicsPath) | Transforms a graphics path from layer coordinates to graph (page) coordinates |
| TransformCoordinatesFromHereToParent(PointD2D) | Transforms a PointD2D from layer coordinates to graph (=printable area) coordinates |
| TransformCoordinatesFromHereToRoot | |
| TransformCoordinatesFromParentToHere(Graphics) | This switches the graphics context from printable area coordinates to layer coordinates. |
| TransformCoordinatesFromParentToHere(PointD2D) | |
| TransformCoordinatesFromRootToHere | |
| TryGetName |
Test if this item already has a name.
(Inherited from SuspendableDocumentNodeBase) |
| VisitDocumentReferences | 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. |
Extension Methods| Name | Description | |
|---|---|---|
 | ArrangeLayers |
Arranges the layers according to the provided options.
(Defined by GraphDocumentLayerArrangement) |
| 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