Class GroupShape
Represents the group shape used by the presentation model.
Inherited Members
Namespace: DRIT.Presentation.Drawing
Assembly: DRIT.Presentation.dll
Syntax
public class GroupShape : AbstractShape, IDrawingObject, IGroupShape
Constructors
GroupShape()
Initializes an empty group shape and its child-shape collection.
Declaration
public GroupShape()
Properties
Charts
Gets all charts contained in this group/slide content.
Declaration
public IEnumerable<PresentationChart> Charts { get; }
Property Value
| Type | Description |
|---|---|
| IEnumerable<PresentationChart> |
Drawings
Gets all drawing objects in their original z-order.
Declaration
public DrawingObjectCollection Drawings { get; }
Property Value
| Type | Description |
|---|---|
| DrawingObjectCollection |
GroupShapes
Gets the nested group shapes contained directly by this group.
Declaration
public IEnumerable<IGroupShape> GroupShapes { get; }
Property Value
| Type | Description |
|---|---|
| IEnumerable<IGroupShape> |
Shapes
Gets the child shapes owned by this group.
Declaration
public ShapeCollection Shapes { get; }
Property Value
| Type | Description |
|---|---|
| ShapeCollection |
Methods
AddAudio(Position, Size, string)
Adds the audio to this group shape.
Declaration
public MediaShape AddAudio(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| MediaShape | The newly added audio. |
AddAudio(double, double, double, double, ScreenMeasurementUnit, string)
Adds the audio to this group shape.
Declaration
public MediaShape AddAudio(double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| MediaShape | The newly added audio. |
AddChart(ChartType, Position, Size, string)
Adds a chart to this group/slide content.
Declaration
public PresentationChart AddChart(ChartType chartType, Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartType | chartType | |
| Position | position | |
| Size | size | |
| string | name |
Returns
| Type | Description |
|---|---|
| PresentationChart |
AddChart(ChartType, double, double, double, double, ScreenMeasurementUnit, string)
Adds the chart to this group shape.
Declaration
public PresentationChart AddChart(ChartType chartType, double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ChartType | chartType | |
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PresentationChart | The newly added chart. |
AddConnector(Position, Size, string)
Adds the connector to this group shape.
Declaration
public ConnectorShape AddConnector(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| ConnectorShape | The newly added connector. |
AddConnector(double, double, double, double, ScreenMeasurementUnit, string)
Adds the connector to this group shape.
Declaration
public ConnectorShape AddConnector(double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| ConnectorShape | The newly added connector. |
AddMathShape(Position, Size, string)
Adds the math shape to this group shape.
Declaration
public Shape AddMathShape(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| Shape | The newly added mathshape. |
AddMathShape(double, double, double, double, ScreenMeasurementUnit, string)
Adds the math shape to this group shape.
Declaration
public Shape AddMathShape(double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| Shape | The newly added mathshape. |
AddOleObject(Position, Size, string)
Adds the ole object to this group shape.
Declaration
public OleShape AddOleObject(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| OleShape | The newly added oleobject. |
AddOleObject(double, double, double, double, ScreenMeasurementUnit, string)
Adds the ole object to this group shape.
Declaration
public OleShape AddOleObject(double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| OleShape | The newly added oleobject. |
AddPicture(Position, Size, string)
Adds the picture to this group shape.
Declaration
public PictureShape AddPicture(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added picture. |
AddPicture(double, double, double, double, ScreenMeasurementUnit, string)
Adds the picture to this group shape.
Declaration
public PictureShape AddPicture(double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added picture. |
AddSectionZoomFrame(Position, Size, Section, string)
Adds the section zoom frame to this group shape.
Declaration
public PictureShape AddSectionZoomFrame(Position position, Size size, Section targetSection, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| Section | targetSection | The target section supplied to this operation. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added sectionzoomframe. |
AddSectionZoomFrame(double, double, double, double, Section, string)
Adds the section zoom frame to this group shape.
Declaration
public PictureShape AddSectionZoomFrame(double x, double y, double width, double height, Section targetSection, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| Section | targetSection | The target section supplied to this operation. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added sectionzoomframe. |
AddShape(ShapeType, Position, Size, string)
Adds a shape at the specified position and size.
Declaration
public Shape AddShape(ShapeType shapeType, Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ShapeType | shapeType | The type of shape to create. |
| Position | position | The position of the shape. |
| Size | size | The size of the shape. |
| string | name | The optional shape name. A generated name is used when this value is null. |
Returns
| Type | Description |
|---|---|
| Shape | The newly added shape. |
AddShape(ShapeType, double, double, double, double, ScreenMeasurementUnit, string)
Adds a shape using coordinate and size values in the specified unit.
Declaration
public Shape AddShape(ShapeType shapeType, double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ShapeType | shapeType | The type of shape to create. |
| double | x | The horizontal position. |
| double | y | The vertical position. |
| double | width | The shape width. |
| double | height | The shape height. |
| ScreenMeasurementUnit | unit | The unit used by the position and size values. |
| string | name | The optional shape name. A generated name is used when this value is null. |
Returns
| Type | Description |
|---|---|
| Shape | The newly added shape. |
AddSlideZoomFrame(Position, Size, Slide, string)
Adds the slide zoom frame to this group shape.
Declaration
public PictureShape AddSlideZoomFrame(Position position, Size size, Slide targetSlide, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| Slide | targetSlide | The target slide supplied to this operation. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added slidezoomframe. |
AddSlideZoomFrame(double, double, double, double, Slide, string)
Adds the slide zoom frame to this group shape.
Declaration
public PictureShape AddSlideZoomFrame(double x, double y, double width, double height, Slide targetSlide, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| Slide | targetSlide | The target slide supplied to this operation. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added slidezoomframe. |
AddSummaryZoomFrame(Position, Size, IEnumerable<Section>, string)
Adds the summary zoom frame to this group shape.
Declaration
public PictureShape AddSummaryZoomFrame(Position position, Size size, IEnumerable<Section> sections, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| IEnumerable<Section> | sections | The sections supplied to this operation. |
| string | name |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added summaryzoomframe. |
AddSummaryZoomFrame(Position, Size, string)
Adds the summary zoom frame to this group shape.
Declaration
public PictureShape AddSummaryZoomFrame(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added summaryzoomframe. |
AddSummaryZoomFrame(double, double, double, double, IEnumerable<Section>, string)
Adds the summary zoom frame to this group shape.
Declaration
public PictureShape AddSummaryZoomFrame(double x, double y, double width, double height, IEnumerable<Section> sections, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| IEnumerable<Section> | sections | The sections supplied to this operation. |
| string | name |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added summaryzoomframe. |
AddSummaryZoomFrame(double, double, double, double, string)
Adds the summary zoom frame to this group shape.
Declaration
public PictureShape AddSummaryZoomFrame(double x, double y, double width, double height, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| PictureShape | The newly added summaryzoomframe. |
AddTable(int, int, Position, Size, string)
Adds the table to this group shape.
Declaration
public TableShape AddTable(int rows, int columns, Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| int | rows | The rows supplied to this operation. |
| int | columns | The columns supplied to this operation. |
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| TableShape | The newly added table. |
AddTable(int, int, double, double, double, double, ScreenMeasurementUnit, string)
Adds the table to this group shape.
Declaration
public TableShape AddTable(int rows, int columns, double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| int | rows | The rows supplied to this operation. |
| int | columns | The columns supplied to this operation. |
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| TableShape | The newly added table. |
AddTextBox(Position, Size, string)
Adds a rectangular text box at the specified position and size.
Declaration
public TextBoxShape AddTextBox(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | The position of the text box. |
| Size | size | The size of the text box. |
| string | name | The optional text box name. A generated name is used when this value is null. |
Returns
| Type | Description |
|---|---|
| TextBoxShape | The newly added text box. |
AddTextBox(ShapeType, Position, Size, string)
Adds the text box to this group shape.
Declaration
public TextBoxShape AddTextBox(ShapeType shapeType, Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ShapeType | shapeType | |
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| TextBoxShape | The newly added textbox. |
AddTextBox(ShapeType, double, double, double, double, ScreenMeasurementUnit, string)
Adds the text box to this group shape.
Declaration
public TextBoxShape AddTextBox(ShapeType shapeType, double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| ShapeType | shapeType | |
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| TextBoxShape | The newly added textbox. |
AddTextBox(double, double, double, double, ScreenMeasurementUnit, string)
Adds the text box to this group shape.
Declaration
public TextBoxShape AddTextBox(double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| TextBoxShape | The newly added textbox. |
AddVideo(Position, Size, string)
Adds the video to this group shape.
Declaration
public MediaShape AddVideo(Position position, Size size, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| MediaShape | The newly added video. |
AddVideo(double, double, double, double, ScreenMeasurementUnit, string)
Adds the video to this group shape.
Declaration
public MediaShape AddVideo(double x, double y, double width, double height, ScreenMeasurementUnit unit, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| MediaShape | The newly added video. |
AddVideoFromUri(Position, Size, string, string)
Adds the video from uri to this group shape.
Declaration
public MediaShape AddVideoFromUri(Position position, Size size, string sourceUri, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | position | |
| Size | size | |
| string | sourceUri | The source uri supplied to this operation. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| MediaShape | The newly added videofromuri. |
AddVideoFromUri(double, double, double, double, ScreenMeasurementUnit, string, string)
Adds the video from uri to this group shape.
Declaration
public MediaShape AddVideoFromUri(double x, double y, double width, double height, ScreenMeasurementUnit unit, string sourceUri, string name = null)
Parameters
| Type | Name | Description |
|---|---|---|
| double | x | The horizontal coordinate, in document units. |
| double | y | The vertical coordinate, in document units. |
| double | width | The width of the object, in document units. |
| double | height | The height of the object, in document units. |
| ScreenMeasurementUnit | unit | The unit used for the conversion. |
| string | sourceUri | The source uri supplied to this operation. |
| string | name | The name assigned to the object. |
Returns
| Type | Description |
|---|---|
| MediaShape | The newly added videofromuri. |