NShape Reference
DiagramSetController Class

<< Click to Display Table of Contents >>

Navigation:  Class Reference > Namespace Dataweb.NShape.Controllers >

NShape Reference
DiagramSetController Class

Previous pageReturn to chapter overviewNext page

Manages the diagrams in the project.

Syntax

public class DiagramSetController : Component

Description

The DiagramSetController provides basic diagram management functionality.

Public Properties

Name

Description

ActiveTool

Specifies the currently active tool for the diagrams.

Diagrams

A list of diagrams managed by this DiagramSetController.

ProductVersion

The version of the component.

Project

Specifies the diagramming project for the controller.

Public Methods

Name

Description

CreateDiagram

Creates a new diagram.

DeleteDiagram

Deletes a diagram.

DiagramControllers

Enumerates the existing diagram controllers.

OpenDiagram

Creates the diagram controller for the indicated diagram.

CloseDiagram

Releases the diagram controller for the indicated diagram.

Public Methods

Name

Description

AggregateCompositeShape

Aggregate selected shapes to a composite shape based on the bottom shape.

CanAggregateShapes

Checks wether the given shapes can be aggregated.

CanCopy

Checks wether the given shapes can be copied.

CanCut

Checks wether the given shapes can be cut.

CanDeleteShapes

Checks wether the given shapes can be deleted.

CanGroupShapes

Checks wether the given shapes can be grouped.

CanInsertShapes

Checks wether the given shapes can be inserted into the given diagram.

CanLiftShapes

Checks wether the given shapes can be lifted.

CanPaste

Checks wether the given shapes can be pasted into the given diagram.

CanSplitShapeAggregation

Checks wether the given shapes can be unaggregated.

CanUngroupShape

Checks wether the given shapes can be ungrouped.

CloseDiagram

Closes the indicated diagram.

Constructor

Constructs a new instance.

Copy

Copies the given shapes.

CreateDiagram

Creates a new diagram with the given name.

Cut

Cuts the given shapes out of the given diagram.

DeleteDiagram

Deletes the indicated diagram.

DeleteShapes

Deletes the given shapes from the given diagram.

GroupShapes

Aggregates the given shapes to a shape group.

InsertShapes

Inserts the given shapes into the given diagram.

LiftShape

Lifts the given shape in the given diagram's shape collection.

ListShapes

Lifts the given shapes in the given diagram's shape collection.

OpenDiagram

Creates a new DiagramController for the indicated diagram.

Paste

Pastes the indicated shapes into the given diagram.

SelectModelObjects

selects all shapes attached to the given model objects.

SplitCompositeShape

Unaggregates the given shapes and inserts them into the given diagram.

UngroupShapes

Ungroups the given shapes and adds them to the given diagram.

Events

Name

Description

DiagramAdded

Occurs when a diagram has been added to the project.

DiagramRemoved

Occurs when a diagram has been removed from the project.

DiagramChanged

Occurs when a diagram has changed.

ShapesChanged

Occurs when one or more shapes have changed.

ShapeSelectionChanged

Occurs when the shape selection in a diagram controller has changed.