SummaryZoomSection
SummaryZoomSection class
Represents a Summary Zoom Section object in a Summary Zoom frame.
addPlaceholder
| Name | Description |
|---|
| addPlaceholder(Placeholder) | Adds a new placeholder if there is no and sets placeholder properties to a specified one. |
Parameters:
| Name | Type | Description |
|---|
| placeholderToCopyFrom | Placeholder | Placeholder to copy content from. |
Result:
Placeholder
getAlternativeText
| Name | Description |
|---|
| getAlternativeText() | Returns or sets the alternative text associated with a shape. Read/write String. |
Result:
String
getAlternativeTextTitle
| Name | Description |
|---|
| getAlternativeTextTitle() | Returns or sets the title of alternative text associated with a shape. Read/write String. |
Result:
String
getBasePlaceholder
| Name | Description |
|---|
| getBasePlaceholder() | Returns a basic placeholder shape (shape from the layout and/or master slide that the current shape is inherited from). A null is returned if the current shape is not inherited. |
Result:
SummaryZoomSection, AutoShape, AudioFrame, OleObjectFrame, SummaryZoomFrame, ZoomFrame, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, GeometryShape, SmartArtShape, SmartArt, Ink, Chart, GroupShape, Table, SectionZoomFrame, Shape, LegacyDiagram, Connector
getBlackWhiteMode
| Name | Description |
|---|
| getBlackWhiteMode() | Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode. |
Result:
byte
getConnectionSiteCount
| Name | Description |
|---|
| getConnectionSiteCount() | Returns the number of connection sites on the shape. Read-only int. |
Result:
int
getCustomData
| Name | Description |
|---|
| getCustomData() | Returns the shape’s custom data. Read-only ICustomData. |
Result:
CustomData
getDescription
| Name | Description |
|---|
| getDescription() | Returns the text description of the Summary Zoom Section object. |
Result:
String
| Name | Description |
|---|
| getEffectFormat() | Returns the EffectFormat object which contains pixel effects applied to a shape. Note: can return null for certain types of shapes which don’t have effect properties. Read-only IEffectFormat. |
Result:
EffectFormat
| Name | Description |
|---|
| getFillFormat() | Returns the FillFormat object that contains fill formatting properties for a shape. Note: can return null for certain types of shapes which don’t have fill properties. Read-only IFillFormat. |
Result:
FillFormat
getFrame
| Name | Description |
|---|
| getFrame() | Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties. |
Result:
ShapeFrame
getGraphicalObjectLock
| Name | Description |
|---|
| getGraphicalObjectLock() | Returns shape’s locks. Read-only IGraphicalObjectLock. |
Result:
GraphicalObjectLock
getHeight
| Name | Description |
|---|
| getHeight() | Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
Result:
float
getHidden
| Name | Description |
|---|
| getHidden() | Determines whether the shape is hidden. Read/write boolean. |
Result:
boolean
getHyperlinkClick
| Name | Description |
|---|
| getHyperlinkClick() | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
Result:
Hyperlink
getHyperlinkManager
| Name | Description |
|---|
| getHyperlinkManager() | Returns the hyperlink manager. Read-only IHyperlinkManager. |
Result:
HyperlinkManager
getHyperlinkMouseOver
| Name | Description |
|---|
| getHyperlinkMouseOver() | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
Result:
Hyperlink
getImage
| Name | Description |
|---|
| getImage() | Gets or sets image for zoom object. Read/write IPPImage. |
Result:
PPImage
getImageType
| Name | Description |
|---|
| getImageType() | Gets or sets the image type of a zoom object. Read/write ZoomImageType. Default value: Preview Specifies whether the Zoom object is using the slide preview or a cover image. |
Result:
int
| Name | Description |
|---|
| getLineFormat() | Returns the LineFormat object that contains line formatting properties for a shape. Note: can return null for certain types of shapes which don’t have line properties. Read-only ILineFormat. |
Result:
LineFormat
getName
| Name | Description |
|---|
| getName() | Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String. |
Result:
String
getOfficeInteropShapeId
| Name | Description |
|---|
| getOfficeInteropShapeId() | Gets unique shape identifier in slide scope. Read-only long. See also ( #getUniqueId) for getting unique shape identifier in presentation scope. |
Result:
long
getParentGroup
| Name | Description |
|---|
| getParentGroup() | Returns parent GroupShape object if shape is grouped. Otherwise returns null. Read-only IGroupShape. Property ( #isGrouped) determines whether the shape is grouped. |
Result:
GroupShape
| Name | Description |
|---|
| getParent_Immediate() | |
getPlaceholder
| Name | Description |
|---|
| getPlaceholder() | Returns the placeholder for a shape. Returns null if the shape has no placeholder. Read-only IPlaceholder. |
Result:
Placeholder
getPresentation
| Name | Description |
|---|
| getPresentation() | Returns the parent presentation of a slide. Read-only IPresentation. |
Result:
Presentation
getRawFrame
| Name | Description |
|---|
| getRawFrame() | Returns or sets the raw shape frame’s properties. Read/write IShapeFrame. |
Result:
ShapeFrame
getReturnToParent
| Name | Description |
|---|
| getReturnToParent() | Gets or sets the navigation behavior in slideshow. Read/write boolean. Default value: false True value of the property specifies return to parent navigation behavior in slideshow. |
Result:
boolean
getRotation
| Name | Description |
|---|
| getRotation() | Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
Result:
float
getShapeLock
| Name | Description |
|---|
| getShapeLock() | Returns shape’s locks. Read-only IBaseShapeLock. |
Result:
BaseShapeLock, PictureFrameLock, AutoShapeLock, GraphicalObjectLock, GroupShapeLock, ConnectorLock
getShowBackground
| Name | Description |
|---|
| getShowBackground() | Gets or sets value that specifies whether the Zoom will use the background of the destination slide. Read/write boolean. Default value: true |
Result:
boolean
getSlide
| Name | Description |
|---|
| getSlide() | Returns the parent slide of a shape. Read-only IBaseSlide. |
Result:
Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide
getTargetSection
| Name | Description |
|---|
| getTargetSection() | Gets or sets the section object that the Section Zoom object links to. Read/write ISection. |
Result:
Section
| Name | Description |
|---|
| getThreeDFormat() | Returns the ThreeDFormat object that 3d effect properties for a shape. Note: can return null for certain types of shapes which don’t have 3d properties. Read-only IThreeDFormat. |
Result:
ThreeDFormat
getThumbnail
| Name | Description |
|---|
| getThumbnail() | Returns shape thumbnail. ShapeThumbnailBounds.Shape shape thumbnail bounds type is used by default. |
Result:
BufferedImage
getThumbnail
| Name | Description |
|---|
| getThumbnail(int, float, float) | Returns shape thumbnail. |
Parameters:
| Name | Type | Description |
|---|
| bounds | int | Shape thumbnail bounds type. |
| scaleX | float | X scale |
| scaleY | float | Y scale |
Result:
BufferedImage
getTitle
| Name | Description |
|---|
| getTitle() | Returns the text title of the Summary Zoom Section object. |
Result:
String
getTransitionDuration
| Name | Description |
|---|
| getTransitionDuration() | Gets or sets the duration of the transition between Zoom and slide. Read/write float. Default value: 1.0f If not specified (TransitionDur = 0), it will use the destination slide transition and the timings associated with that transition. |
Result:
float
getUniqueId
| Name | Description |
|---|
| getUniqueId() | Gets unique shape identifier in presentation scope. Read-only long. See also ( #getOfficeInteropShapeId) for getting unique shape identifier in slide scope. |
Result:
long
getWidth
| Name | Description |
|---|
| getWidth() | Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
Result:
float
getX
| Name | Description |
|---|
| getX() | Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
Result:
float
getY
| Name | Description |
|---|
| getY() | Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
Result:
float
getZOrderPosition
| Name | Description |
|---|
| getZOrderPosition() | Returns the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only int. |
Result:
int
isGrouped
| Name | Description |
|---|
| isGrouped() | Determines whether the shape is grouped. Read-only boolean. Property ( #getParentGroup) returns parent GroupShape object if shape is grouped. |
Result:
boolean
isTextHolder
| Name | Description |
|---|
| isTextHolder() | Determines whether the shape is TextHolder_PPT. Read-only boolean. |
Result:
boolean
removePlaceholder
| Name | Description |
|---|
| removePlaceholder() | Defines that this shape isn’t a placeholder. |
setAlternativeText
| Name | Description |
|---|
| setAlternativeText(String) | Returns or sets the alternative text associated with a shape. Read/write String. |
setAlternativeTextTitle
| Name | Description |
|---|
| setAlternativeTextTitle(String) | Returns or sets the title of alternative text associated with a shape. Read/write String. |
setBlackWhiteMode
| Name | Description |
|---|
| setBlackWhiteMode(byte) | Property specifies how a shape will render in black-and-white display mode.. Read/write BlackWhiteMode. |
setDescription
| Name | Description |
|---|
| setDescription(String) | Returns the text description of the Summary Zoom Section object. |
setFrame
| Name | Description |
|---|
| setFrame(ShapeFrame) | Returns or sets the shape frame’s properties. Read/write IShapeFrame. Value of each property of the returned IShapeFrame instance is not undefined (is not NaN or NotDefined). Value of each property of the assigned IShapeFrame instance must be not undefined (must be not NaN or NotDefined). You can set undefined values for RawFrame instance properties. |
setHeight
| Name | Description |
|---|
| setHeight(float) | Returns or sets the height of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
setHidden
| Name | Description |
|---|
| setHidden(boolean) | Determines whether the shape is hidden. Read/write boolean. |
setHyperlinkClick
| Name | Description |
|---|
| setHyperlinkClick(Hyperlink) | Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink. |
setHyperlinkMouseOver
| Name | Description |
|---|
| setHyperlinkMouseOver(Hyperlink) | Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink. |
setImage
| Name | Description |
|---|
| setImage(PPImage) | Gets or sets image for zoom object. Read/write IPPImage. |
setImageType
| Name | Description |
|---|
| setImageType(int) | Gets or sets the image type of a zoom object. Read/write ZoomImageType. Default value: Preview Specifies whether the Zoom object is using the slide preview or a cover image. |
setName
| Name | Description |
|---|
| setName(String) | Returns or sets the name of a shape. Must be not null. Use empty string value if needed. Read/write String. |
setRawFrame
| Name | Description |
|---|
| setRawFrame(ShapeFrame) | Returns or sets the raw shape frame’s properties. Read/write IShapeFrame. |
setReturnToParent
| Name | Description |
|---|
| setReturnToParent(boolean) | Gets or sets the navigation behavior in slideshow. Read/write boolean. Default value: false True value of the property specifies return to parent navigation behavior in slideshow. |
setRotation
| Name | Description |
|---|
| setRotation(float) | Returns or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
setShowBackground
| Name | Description |
|---|
| setShowBackground(boolean) | Gets or sets value that specifies whether the Zoom will use the background of the destination slide. Read/write boolean. Default value: true |
setTargetSection
| Name | Description |
|---|
| setTargetSection(Section) | Gets or sets the section object that the Section Zoom object links to. Read/write ISection. |
setTitle
| Name | Description |
|---|
| setTitle(String) | Returns the text title of the Summary Zoom Section object. |
setTransitionDuration
| Name | Description |
|---|
| setTransitionDuration(float) | Gets or sets the duration of the transition between Zoom and slide. Read/write float. Default value: 1.0f If not specified (TransitionDur = 0), it will use the destination slide transition and the timings associated with that transition. |
setWidth
| Name | Description |
|---|
| setWidth(float) | Returns or sets the width of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
setX
| Name | Description |
|---|
| setX(float) | Returns or sets the x-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
setY
| Name | Description |
|---|
| setY(float) | Returns or sets the y-coordinate of the upper-left corner of the shape. Read/write float. Returned value is always defined (is not Float.NaN). Assigned value must be defined (not Float.NaN). You can set undefined values for RawFrame instance properties. |
writeAsSvgToBytes
| Name | Description |
|---|
| writeAsSvgToBytes () | Saves content of Shape as SVG file. |
Result:
Bytes[]
writeAsSvgToBytes
| Name | Description |
|---|
| writeAsSvgToBytes (SVGOptions) | Saves content of Shape as SVG file. |
Parameters:
| Name | Type | Description |
|---|
| svgOptions | SVGOptions | SVG generation options |
Result:
Bytes[]