LayoutSlide

LayoutSlide class

Represents a layout slide.

createThemeEffective

Name	Description
createThemeEffective()	Returns an effective theme for this slide.

Result: ThemeEffectiveData

---

equals

Name	Description
equals(Slide)	Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

Name	Type	Description
slide	Slide	The IBaseSlide to compare with the current IBaseSlide.

Result: boolean

---

equals

Name	Description
equals(MasterNotesSlide)	Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

Name	Type	Description
slide	MasterNotesSlide	The IBaseSlide to compare with the current IBaseSlide.

Result: boolean

---

equals

Name	Description
equals(MasterSlide)	Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

Name	Type	Description
slide	MasterSlide	The IBaseSlide to compare with the current IBaseSlide.

Result: boolean

---

equals

Name	Description
equals(LayoutSlide)	Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

Name	Type	Description
slide	LayoutSlide	The IBaseSlide to compare with the current IBaseSlide.

Result: boolean

---

equals

Name	Description
equals(MasterHandoutSlide)	Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

Name	Type	Description
slide	MasterHandoutSlide	The IBaseSlide to compare with the current IBaseSlide.

Result: boolean

---

equals

Name	Description
equals(NotesSlide)	Determines whether the two IBaseSlide instances are equal. Returning value is calculated based on slide’s structure and static content. Two slides are equal if all shapes, styles, texts, animation and other settings. etc. are equal. The comparison doesn’t take into account unique identifier values, e.g. SlideId and dynamic content, e.g. current date value in Date Placeholder.

Parameters:

Name	Type	Description
slide	NotesSlide	The IBaseSlide to compare with the current IBaseSlide.

Result: boolean

---

findShapeByAltText

Name	Description
findShapeByAltText(String)	Finds first occurrence of a shape with the specified alternative text.

Parameters:

Name	Type	Description
altText	String	Alternative text.

Result: SummaryZoomSection, AutoShape, AudioFrame, OleObjectFrame, SummaryZoomFrame, ZoomFrame, GraphicalObject, PictureFrame, ZoomObject, VideoFrame, GeometryShape, SmartArtShape, SmartArt, Ink, Chart, GroupShape, Table, SectionZoomFrame, Shape, LegacyDiagram, Connector

---

getBackground

Name	Description
getBackground()	Returns slide’s background. Read-only IBackground.

Result: Background

---

getControls

Name	Description
getControls()	Returns the collection of ActiveX controls on a slide. Read-only IControlCollection.

Result: ControlCollection

---

getCustomData

Name	Description
getCustomData()	Returns the slide’s custom data. Read-only ICustomData.

Result: CustomData

---

getDependingSlides

Name	Description
getDependingSlides()	Returns an array with all slides, which depend on this layout slide.

Result: Slide

---

getHeaderFooterManager

Name	Description
getHeaderFooterManager()	Returns HeaderFooter manager of the layout slide. Read-only ILayoutSlideHeaderFooterManager.

Result: LayoutSlideHeaderFooterManager

---

getHyperlinkQueries

Name	Description
getHyperlinkQueries()	Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries.

Result: HyperlinkQueries

---

getLayoutType

Name	Description
getLayoutType()	Returns layout type of this layout slide. Read-only SlideLayoutType.

Result: byte

---

getMasterSlide

Name	Description
getMasterSlide()	Returns or sets the master slide for a layout. Read/write IMasterSlide.

Result: MasterSlide

---

getName

Name	Description
getName()	Returns or sets the name of a slide. Read/write String.

Result: String

---

getParent_Immediate

Name	Description
getParent_Immediate()

---

getPresentation

Name	Description
getPresentation()	Returns IPresentation interface. Read-only IPresentation.

Result: Presentation

---

getShapes

Name	Description
getShapes()	Returns the shapes of a slide. Read-only IShapeCollection.

Result: ShapeCollection

---

getShowMasterShapes

Name	Description
getShowMasterShapes()	Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean.

Result: boolean

---

getShowMasterShapes

Name	Description
getShowMasterShapes()	Specifies if shapes on the master slide should be shown on slides or not. For master slide itself this property always returns false. Read/write boolean.

Result: boolean

Error

Error	Condition
NotSupportedException	Thrown if set true for master slide.

---

getSlide

Name	Description
getSlide()

Result: Slide, MasterNotesSlide, BaseSlide, MasterSlide, LayoutSlide, MasterHandoutSlide, NotesSlide

---

getSlideId

Name	Description
getSlideId()	Returns the ID of a slide. Read-only long.

Result: long

---

getSlideShowTransition

Name	Description
getSlideShowTransition()	Returns the Transition object which contains information about how the specified slide advances during a slide show. Read-only ISlideShowTransition.

Result: SlideShowTransition

---

getThemeManager

Name	Description
getThemeManager()	Returns the overriding theme manager. Read-only IOverrideThemeManager.

Result: LayoutSlideThemeManager, ChartThemeManager, BaseOverrideThemeManager, NotesSlideThemeManager, SlideThemeManager

---

getTimeline

Name	Description
getTimeline()	Returns animation timeline object. Read-only IAnimationTimeLine.

Result: AnimationTimeLine

---

hasDependingSlides

Name	Description
hasDependingSlides()	Returns true if there exists at least one slide that depends on this layout slide. Read-only boolean.

Result: boolean

---

joinPortionsWithSameFormatting

Name	Description
joinPortionsWithSameFormatting()	Joins runs with same formatting in all paragraphs all acceptable shapes.

---

joinPortionsWithSameFormatting

Name	Description
joinPortionsWithSameFormatting(ShapeCollection)	Joins runs with same formatting in all paragraphs in all acceptable shapes.

---

remove

Name	Description
remove()	Removes layout from presentation.

Error

Error	Condition
PptxEditException	Thrown if layout is already removed from presentation or if layout is used in presentation (its HasDependingSlides property is true). To avoid throwing of the PptxEditException check layout’s HasDependingSlides property before.

---

setMasterSlide

Name	Description
setMasterSlide(MasterSlide)	Returns or sets the master slide for a layout. Read/write IMasterSlide.

---

setName

Name	Description
setName(String)	Returns or sets the name of a slide. Read/write String.

---

setShowMasterShapes

Name	Description
setShowMasterShapes(boolean)	Specifies if shapes on the master slide should be shown on slides or not. Read/write boolean.

---

setShowMasterShapes

Name	Description
setShowMasterShapes(boolean)	Specifies if shapes on the master slide should be shown on slides or not. For master slide itself this property always returns false. Read/write boolean.

Error

Error	Condition
NotSupportedException	Thrown if set true for master slide.

---