NevronOpenVision
Nevron.Nov.Diagram Namespace / NShape Class


In This Topic
    NShape Class Methods
    In This Topic

    For a list of all members of this type, see NShape members.

    Public Methods
     NameDescription
    Public MethodAlignInPageSets the left-top corner of the shape Alignment Box in page coordinates to be the specified point. This method is internally performing a translation of the shape.  
    Public MethodAppendContextMenuItemsOverridden. Appends custom context menu items.  
    Public MethodCanClipOverridden. Overriden to return true.  
    Public MethodCanTransformOverridden. Overriden to return true  
    Public Methodstatic (Shared in Visual Basic)CreateEllipseCreates an ellipse shape  
    Public Methodstatic (Shared in Visual Basic)CreateLineShapeInitializes a 1D shape, the geometry of which draws a line from the Begin to the End point of the shape.  
    Public Methodstatic (Shared in Visual Basic)CreateRectangleCreates a 2D shape, the geometry of which draws a rectangle inside the WH box.  
    Public MethodGetAbilitiesMaskOverridden. Overriden to return the shape abilities  
    Public MethodGetAccessibleShapesGets a list of the accessible shapes (e.g. NeighbourShapes + the accessible shapes of the neighbour shapes)  
    Public MethodGetAlignBoxInPageGets the alignment box of the shape. For a 2D shape this is the bounds of the shape box projection in page coordinates. For a 1D shape this is the bounds of the shape end-points projection in page coordinates.  
    Public MethodGetAlignBoxInParentGets the alignment box of the shape. For a 2D shape this is the bounds of the shape box projection in parent coordinates. For a 1D shape this is the bounds of the shape end-points projection in parent coordinates.  
    Public MethodGetBeginPointGets the begin point of the shape (in parent coordinates)  
    Public MethodGetBeginPointInDrawingGets the begin point of the shape in drawing coordinates  
    Public MethodGetBeginPointInPageGets the begin point of the shape in page coordinates  
    Public MethodGetClipOverridden. Gets the shape clipping region.  
    Public MethodGetDestinationShapesGets a list of the destination shapes (e.g. the shapes which are connected to the end plug of outgoing shapes).  
    Public MethodGetDisplayBoundsGets the current display bounds of this shape (in local coordinates).  
    Public MethodGetDisplayBoundsInPageGets the display bounds of the shape in page coordinates.  
    Public MethodGetEndPointGets the end point of the shape (in parent coordinates)  
    Public MethodGetEndPointInDrawingGets the end point of the shape in drawing coordinates  
    Public MethodGetEndPointInPageGets the end point of the shape (in page coordinates)  
    Public MethodGetFromToShapesGets a list of the shapes to whose inward ports, the plugs of this shape are connected  
    Public MethodGetIncomingShapesGets a list of the 1D shapes whose end plug is connected to an inward port of this shape  
    Public MethodGetLocPinPointGets the local pin point position (in local coordinates).  
    Public MethodGetMoveSlavesGets a list of shapes which will be moved when this shape is moved.  
    Public MethodGetNeighbourShapesGets the union of the Source and Destination shapes.  
    Public MethodGetOutgoingShapesGets a list of the 1D shapes whose start plug is connected to an inward port of this shape  
    Public MethodGetPaintCacheModeOverridden. Determines whether the 2D painting of the object can be cached.  
    Public MethodGetPinPointGets the pin point position (in parent coordinates).  
    Public MethodGetPinPointInPageGets the pin point position in page coordinates.  
    Public MethodGetPinPointInWHBoxGets the pin point position (in local coordinates)  
    Public MethodGetPortByNameGets the first port with the specified name. Returns null if no such port exists.  
    Public MethodGetPredecessorShapesGets a list of the predecessor shapes (e.g. SourceShapes + the predecessor shapes of the source shapes)  
    Public MethodGetProtectionMaskOverridden. Overriden to add additional shape specific protection  
    Public MethodGetReflexiveShapesGets a list of the 1D shapes whose start and end plugs are connected to inward port(s) of this shape (e.g. 1D shapes, which start and end in this shape)  
    Public MethodGetShapeStyleGets the shape style to apply to this styleable element.  
    Public MethodGetSlaveShapesGets a list of the shapes, which consider this shape as master (i.e. are glued in a master-slave manner)  
    Public MethodGetSnappedBoxDirectionGets the snapped box direction  
    Public MethodGetSourceShapesGets a list of the source shapes (e.g. the shapes which are connected to the start plug of incoming shapes).  
    Public MethodGetSuccessorShapesGets a list of the successor shapes (e.g. DestinationShapes + the successor shapes of the destination shapes)  
    Public MethodGetTableBlockHelper method that gets a NTableBlock object  
    Public MethodGetTextBlockHelper method that gets a NTextBlock object  
    Public MethodGetTextBlockContentNoCreateGets the text block content without creating a text block if it not already created  
    Public MethodGetTextSelectionGets the text selection  
    Public MethodGetThemeInfoGets the theme properties to use for styling this styleable element.  
    Public MethodGetTransformOverridden. Gets the matrix that transforms local to parent coordinates.  
    Public MethodGetWHBoxGets the box formed by the shape Width and Height (in shape local coordinates)  
    Public MethodGetWHBoxInParentGets the box formed by the shape Width and Height, projected to the shape parent coordinates.  
    Public MethodGlueBeginToGeometryContourOverloaded. Glues (connects) the begin point of this shape to a factor location on the specified FROM shape geometry contour. 0 is the begin of the countour, 1 is the end of the contour.  
    Public MethodGlueBeginToGeometryIntersectionGlues (connects) the begin point of this shape to the intersection point between the vector formed by the FROM shape center and the begin-point direction vector and the FROM shape geometry.  
    Public MethodGlueBeginToGeometryVertexGlues the begin point of the shape to the vertex of the specified geometry command.  
    Public MethodGlueBeginToNearestPortGlues the begin point of this shape to the nearest port of the specified FROM shape.  
    Public MethodGlueBeginToPortGlues the begin point of this shape to the specified port  
    Public MethodGlueBeginToShapeGlues the begin point to the specified shape. The type of glue that is performed depends on the shape.DefaultShapeGlue property.  
    Public MethodGlueBeginToShapeBoxGlues the begin point of the shape to a point defined by factors in the specified FROM shape box.  
    Public MethodGlueBeginToShapeBoxIntersectionGlues (connects) the begin point of this shape to the intersection point between the vector formed by the FROM shape center and the begin-point direction vector and the FROM shape Width/Height box.  
    Public MethodGlueBeginToShapeLineGlues the begin point of the shape to a factor location along the FROM shape line. 0 is the begin of the line, 1 is the end of the line.  
    Public MethodGlueEndToGeometryContourOverloaded. Glues (connects) the end point of this shape to a factor location on the specified TO shape geometry contour. 0 is the end of the countour, 1 is the end of the contour.  
    Public MethodGlueEndToGeometryIntersectionGlues (connects) the end point of this shape to the intersection point between the vector formed by the TO shape center and the end-point direction vector and the TO shape geometry.  
    Public MethodGlueEndToGeometryVertexGlues the end point of the shape to the vertex of the specified geometry command.  
    Public MethodGlueEndToNearestPortGlues the end point of this shape to the nearest port of the specified TO shape.  
    Public MethodGlueEndToPortGlues the end point of this shape to the specified port  
    Public MethodGlueEndToShapeGlues the end point to the specified shape. The type of glue that is performed depends on the shape.DefaultShapeGlue property.  
    Public MethodGlueEndToShapeBoxGlues the end point of the shape to a point defined by factors in the specified TO shape box.  
    Public MethodGlueEndToShapeBoxIntersectionGlues (connects) the end point of this shape to the intersection point between the vector formed by the TO shape center and the end-point direction vector and the TO shape Width/Height box.  
    Public MethodGlueEndToShapeLineGlues the end point of the shape to a factor location along the TO shape line. 0 is the begin of the line, 1 is the end of the line.  
    Public MethodGlueMasterPortToPortGlues (connects) a port of this shape to a port of the master shape. This type of glue translates the shape to match the port locations, and rotates the shape to match the port directions.  
    Public MethodHitTestOverloaded. Overridden. Hit tests a shape by point  
    Public MethodInit1DShapeHelper method for setting up a 1D shape. Sets the ShapeType to 1D.

    If xformType is Vector, the shape transform is initialized as a vector connecting the begin and end points, such that: Binds the Width to the distance between the Begin and End points. Binds the Angle to the angle formed by the line connecting the Begin and End points and the X axis. Binds the PinX and PinY to the middle point of the line connecting the Begin and End points. Binds the LocPinX and LocPinY to the center of the shape local alignment box.

    If xformType is Box, the shape transform is initialized as a vector connecting the begin and end points, such that: Binds the Width to the X distance between the Begin and End points. Binds the Height to the Y distance between the Begin and End points. Sets the angle to zero. Binds the PinX and PinY to the middle point of the line connecting the Begin and End points. Binds the LocPinX and LocPinY to the center of the shape.

     
    Public MethodInit2DShapeHelper method that sets the ShapeType to Shape2D and places the local pin point inside the center of the shape Width and Height (via expressions). Additionally, if the shape was previously a Shape1D, this method unglues the Begin and End points and destroys any expressions associated with the shape Angle, Width, Height, PinX and PinY properties. ShapeType = ENShapeType.Shape2D; SetFx(NShape.LocPinXProperty, new NShapeWidthFactorFx(0.5f)); SetFx(NShape.LocPinYProperty, new NShapeHeightFactorFx(0.5f));  
    Public MethodInvalidateArrangeFromChildCalled by child or descendant arrange elements that consider this element as arrange parent, and want to inform it to invalidate it's arrange.  
    Public MethodInvalidateMeasureFromChildCalled by child or descendant measure elements that consider this element as measure parent, and want to inform it to invalidate it's measure.  
    Public Methodstatic (Shared in Visual Basic)IsConnectorGets whether the given shape is a connector, which is true if it is a 1D shape and its UserClass is equal to "Connector".  
    Public MethodLocalToParentOverloaded. Overridden. Transforms a point in local coordinates to the coordinates of its parent coordinate system  
    Public MethodMoveTextBlockBelowShapeMoves the text block of the shape below it.  
    Public MethodParentToLocalOverloaded. Overridden. Transforms a point in parent coordinates to local coordinates  
    Public MethodRaiseQueryAutoConnectButtonContentRaises the QueryShowAutoConnectButton event  
    Public MethodResizeOverloaded. Resizes the shape box by setting the specified value to the box point corresponding to a compass direction.  
    Public MethodRotateRotates the shape with the specified angle amount. Internally this method calls SetAngle with a value equal to Angle + angle.  
    Public MethodSetAngleSets the shape angle relatively to its parent (i.e. Page or Group). This operation unglues the shape from its master (if any). If the shape is inside the page, this method sets a constant value to the Angle property. If the shape is inside a group, this method also updates the expressions of the Width and Height properties, depending on the ResizeInGroup setting.  
    Public MethodSetArrangeSlotOverloaded. Sets the arrange slot of the shape and positions it into it taking into account the horizontal and vertical placement specified in the LayoutData.  
    Public MethodSetBeginPointSets a constant begin point of the shape (in parent coordinates). This implementation Unglues the begin point.  
    Public MethodSetBoundsOverloaded. Sets the bounding box the shape to be the specified rectangle (in parent coordinates).  
    Public MethodSetEndPointSets a constant end point of the shape (in parent coordinates). This implementation Unglues the end point.  
    Public MethodSetHeightSets the shape Height. If the shape is inside a group, this method updates the expression for shape Height. If the shape is inside a page, this method sets a constant value to the shape Height.  
    Public MethodSetLocPinPointOverloaded. Sets the local pin point position (in local coordinates). By default the local pin point is specified relatively to the shape width and height. This implementation sets proportional expressions to the LocPinX and LocPinY properties.  
    Public MethodSetPinPointOverloaded. Sets the pin point position (in parent coordinates). This operation unglues the shape from its master (if any). If the shape resides in a group, the Pin is expressed as factor expressions of the group dimensions. If the shape resides in a page, the Pin is set to constant values.  
    Public MethodSetShapePropertyValueOverloaded. Sets the shape property with the given name.  
    Public MethodSetWidthSets the shape Width. If the shape is inside a group, this method updates the expression for shape Width. If the shape is inside a page, this method sets a constant value to the shape Width.  
    Public MethodShowPropertiesDialogOverridden. Shows the shape properties dialog  
    Public MethodSplitSplits this shape with the given 2D shape. Works only if this shape is a splittable 1D shape (Splittable = true) and the given 2D shape can split shapes (CanSplit = true).  
    Public MethodStartInplaceEditingOverloaded. Starts inplace editing for this shape, by showing the inplace editor of the shape.  
    Public MethodTranslateOverridden. Translate this item with the specified amounts. For 2D shapes this method translates the PinPoint, For 1D shapes this method translates the BeginPonit and EndPoint of the shape.  
    Public MethodTranslate1DTranslates a 1D shape, by offseting the begin and end points of the shape. The modification of both the begin and end points of the shape is optional. Throws an exception if this is not a 1D shape.  
    Public MethodTranslate2DTranslates a 2D shape, by offseting the PinPoint with the specified amounts. Throws an exception if this is not a 2D shape.  
    Public MethodTryGetBoundsTries to get the specified shape bounds (in shape coordinates)  
    Public MethodTryGetShapePropertyValueOverloaded. Tries to get the value of the specified property for the this shape by converting the variant value of the property to the given type.  
    Public MethodTryGlueEndPointOverloaded. Glues the begin or end point of the shape to a snap point result. Returns true, if successfully glued to a port, shape or geometry. Otherwise returns false.  
    Public MethodUnglueAllDestroys the shape begin glue, end glue and master glue, if any.  
    Public MethodUnglueBeginUnglues the begin point  
    Public MethodUnglueEndUnglues the end point  
    Public MethodUnglueFromIncommingShapeUnglues this shape from the specified incomming shape. If the specified shape is not an incomming shape, does nothing.  
    Public MethodUnglueFromMasterUnglues (disconnects) the outward connection of this shape if any.  
    Public MethodUnglueFromOutgoingShapeUnglues this shape from the specified outgoing shape. If the specified shape is not an outgoing shape, does nothing.  
    Public MethodUpdateBoundsUpdates the Width and Height box of the shape to encompass the geometry and inner shapes of the shape. This operation should be carefully used, since it refactors the geometry expressions to be proportional to the new shape bounds.  
    Public MethodValidateArrangeOverridden. Validates the arrange of the element  
    Top
    Protected Methods
     NameDescription
    Protected MethodAbortInplaceEditingAborts the inplace editing  
    Protected MethodArrangeContentLayouts the content of the element inside the specified content area  
    Internal MethodASbOverridden.   
    Internal MethodAvhj  
    Internal MethodbSb  
    Internal MethodbUhj  
    Internal MethodbYhj  
    Protected MethodCommitInplaceEditingCommits the inplace editing of the specified editor. Note that the editor must be created by this shape's CreateInplaceEditor method.  
    Protected MethodCreateActionCommandsCreates the action commands - Flip HV/Rotate.  
    Protected MethodCreateCustomCommandsCreates the custom commands.  
    Protected MethodCreateFormatGeometryCommandsMenuItemCreates the View menu item, that contains formatting commands like Fill, Stroke and Shadow.  
    Protected MethodCreateFormatTextBlockCommandsMenuItemCreates the Format Text menu item, that contains formatting commands like Fill, Stroke and Shadow.  
    Protected MethodCreateGeometryCalled to create a default geometry.  
    Protected MethodCreateImageBlockCalled to create a default image block.  
    Protected MethodCreateInplaceEditorCreates the inplace edit control that this shape must use. This implementation creates a text box that is sized to the text block and positioned to the text block pin.  
    Protected MethodCreateInplaceEditorContentCreates and initializes the content of the scpecified inplace editor. This implementation creates a text box.  
    Protected MethodCreateStyleCalled to create the default shape style.  
    Protected MethodCreateTextBlockCalled to create a default text block.  
    Internal MethodCSb  
    Internal MethodCthj  
    Internal MethodCvhj  
    Internal Methodstatic (Shared in Visual Basic)CYhj  
    Internal MethoddSb  
    Internal MethodESb  
    Internal MethodEvhj  
    Internal MethodEWhj  
    Internal Methodstatic (Shared in Visual Basic)EYhj  
    Internal MethodfSb  
    Internal MethodfShj  
    Internal MethodGSbOverridden.   
    Internal MethodGvhj  
    Internal MethodhSbOverridden.   
    Internal Methodstatic (Shared in Visual Basic)hYhj  
    Internal MethodISb  
    Internal MethodIUhj  
    Internal MethodIvhj  
    Internal Methodjrhj  
    Internal MethodjSb  
    Internal MethodKSb  
    Internal MethodKvhj  
    Internal MethodlSbOverridden.   
    Protected MethodMeasureContentMeasures the desired size of the element content  
    Internal MethodMSbOverridden.   
    Internal MethodMvhj  
    Internal MethodnSb  
    Protected MethodOnAncestorsChangedOverridden. Updates any references or cache related to the visitor of the node ancestors  
    Protected Internal MethodOnBeginPointGlueChangedCalled when the BeginPointGlue has changed.  
    Protected MethodOnChildInsertedOverridden. Called when a child node has been inserted  
    Protected MethodOnChildRemovedOverridden. Called when a child node has been removed  
    Protected MethodOnChildrenChangedOverridden. Updates any references or cache related to the visitor of the node children  
    Protected MethodOnCodeBehindSourceChangedCalled when the shape behavior has changed.  
    Protected Internal MethodOnControlsChangedCalled whenever the geometries count or properties have changed. Raises the ControlsChanged event.  
    Protected MethodOnDeserializedOverridden. Called when the node is deserialized  
    Protected Internal MethodOnEndPointGlueChangedCalled when the BeginGlue or EndGlue has changed.  
    Protected MethodOnEndPointsChangedCalled whenever the geometries count or properties have changed. Raises the EndPoints event.  
    Protected Internal MethodOnGeometryChangedCalled whenever the geometry has changed. Raises the GeometryChanged event.  
    Protected Internal MethodOnMasterGlueChangedCalled when the MasterElementRef property has changed.  
    Protected MethodOnOwnerPageChangedOverridden. Called when the owner page of the shape has changed.  
    Protected Internal MethodOnPageTransformChangedCalled when the transformation from local to page coordinates of this shape has changed. Raises the page transform changed event.  
    Protected MethodOnPermissionsChangedOverridden. Called when the item permissions have changed.  
    Protected Internal MethodOnPortsChangedCalled whenever the ports count or ports properties have changed. Raises the PortsChanged event.  
    Protected MethodOnPostPaintOverridden. Performs the element post-children custom paint.  
    Protected MethodOnPrePaintOverridden. Performs the element pre-children custom paint.  
    Protected MethodOnShapeTypeChangedCalled when the ShapeType has changed.  
    Protected MethodOnShowHandlesChangedCalled when the ShowHandles has changed.  
    Protected MethodOnSizeChangedCalled whenever the Width or Height properties have changed. Raises the SizeChanged event.  
    Protected MethodOnSizeChangingCalled whenever the Width or Height properties are about to change  
    Protected Internal MethodOnTextBlockChangedCalled when the TextBlock has changed  
    Protected MethodOnTransformChangedCalled when the transformation from local to parent coordinates of this shape has changed. Raises the transform changed event.  
    Protected MethodOnVisibleChangedCalled when the Visible property has changed.  
    Internal MethodOSb  
    Internal Methodprhj  
    Internal MethodpSb  
    Internal MethodpShj  
    Internal Methodpvhj  
    Internal MethodQSb  
    Internal MethodrSb  
    Protected MethodSkipBranchDisplayTraversalOverridden. Determines whether the visitor needs to visit this displayable branch.  
    Internal MethodSrhj  
    Internal MethodSSb  
    Protected MethodStartEditingFocuses the inplace editor content  
    Internal MethodSvhj  
    Internal MethodtSbOverridden.   
    Internal MethodtShj  
    Internal MethodUrhj  
    Internal MethodUSbOverridden.   
    Internal MethodUUhj  
    Internal MethodUvhj  
    Internal MethodvSbOverridden.   
    Internal MethodWSbOverridden.   
    Internal MethodWvhj  
    Internal MethodxSbOverridden.   
    Internal MethodxShj  
    Internal Methodxthj  
    Internal MethodxUhj  
    Internal MethodYvhj  
    Top
    See Also

    Reference

    NShape Class
    Nevron.Nov.Diagram Namespace

     

     

    Copyright © 1998 - 2024 Nevron Software LLC. All rights reserved. Contact Us

    Send Feedback