unioffice: github.com/unidoc/unioffice/presentation Index | Files

package presentation

import "github.com/unidoc/unioffice/presentation"

Index

Package Files

image.go open.go placeholder.go presentation.go read.go slide.go slidelayout.go slidemaster.go textbox.go

type Image Uses

type Image struct {
    // contains filtered or unexported fields
}

Image is an image within a slide.

func (Image) Properties Uses

func (i Image) Properties() drawing.ShapeProperties

Properties returns the properties of the TextBox.

type PlaceHolder Uses

type PlaceHolder struct {
    // contains filtered or unexported fields
}

PlaceHolder is a place holder from a slide.

func (PlaceHolder) AddParagraph Uses

func (s PlaceHolder) AddParagraph() drawing.Paragraph

AddParagraph adds a new paragraph to a placeholder.

func (PlaceHolder) Clear Uses

func (s PlaceHolder) Clear()

Clear clears the placeholder contents and adds a single empty paragraph. The empty paragrah is required by PowerPoint or it will report the file as being invalid.

func (PlaceHolder) ClearAll Uses

func (s PlaceHolder) ClearAll()

ClearAll completely clears a placeholder. To be useable, at least one paragraph must be added after ClearAll via AddParagraph.

func (PlaceHolder) Index Uses

func (s PlaceHolder) Index() uint32

Index returns the placeholder index

func (PlaceHolder) Paragraphs Uses

func (s PlaceHolder) Paragraphs() []drawing.Paragraph

Paragraphs returns the paragraphs defined in the placeholder.

func (PlaceHolder) Remove Uses

func (s PlaceHolder) Remove() error

func (PlaceHolder) SetText Uses

func (s PlaceHolder) SetText(text string)

SetText sets the text of a placeholder for the initial paragraph. This is a shortcut method that is useful for things like titles which only contain a single paragraph.

func (PlaceHolder) Type Uses

func (s PlaceHolder) Type() pml.ST_PlaceholderType

Type returns the placeholder type

func (PlaceHolder) X Uses

func (s PlaceHolder) X() *pml.CT_Shape

X returns the inner wrapped XML type.

type Presentation Uses

type Presentation struct {
    common.DocBase
    // contains filtered or unexported fields
}

Presentation is the a presentation base document.

func New Uses

func New() *Presentation

New initializes and reurns a new presentation

func Open Uses

func Open(filename string) (*Presentation, error)

Open opens and reads a document from a file (.pptx).

func OpenTemplate Uses

func OpenTemplate(fn string) (*Presentation, error)

func Read Uses

func Read(r io.ReaderAt, size int64) (*Presentation, error)

Read reads a document from an io.Reader.

func (*Presentation) AddDefaultSlideWithLayout Uses

func (p *Presentation) AddDefaultSlideWithLayout(l SlideLayout) (Slide, error)

AddDefaultSlideWithLayout tries to replicate what PowerPoint does when inserting a slide with a new style by clearing placeholder content and removing some placeholders. Use AddSlideWithLayout if you need more control.

func (*Presentation) AddImage Uses

func (p *Presentation) AddImage(i common.Image) (common.ImageRef, error)

AddImage adds an image to the document package, returning a reference that can be used to add the image to a run and place it in the document contents.

func (*Presentation) AddSlide Uses

func (p *Presentation) AddSlide() Slide

AddSlide adds a new slide to the presentation.

func (*Presentation) AddSlideWithLayout Uses

func (p *Presentation) AddSlideWithLayout(l SlideLayout) (Slide, error)

AddSlideWithLayout adds a new slide with content copied from a layout. Normally you should use AddDefaultSlideWithLayout as it will do some post processing similar to PowerPoint to clear place holder text, etc.

func (*Presentation) GetImageByRelID Uses

func (p *Presentation) GetImageByRelID(relID string) (common.ImageRef, bool)

GetImageByRelID returns an ImageRef with the associated relation ID in the document.

func (*Presentation) GetLayoutByName Uses

func (p *Presentation) GetLayoutByName(name string) (SlideLayout, error)

GetLayoutByName retrieves a slide layout given a layout name.

func (*Presentation) RemoveSlide Uses

func (p *Presentation) RemoveSlide(s Slide) error

RemoveSlide removes a slide from a presentation.

func (*Presentation) Save Uses

func (p *Presentation) Save(w io.Writer) error

Save writes the presentation out to a writer in the Zip package format

func (*Presentation) SaveToFile Uses

func (p *Presentation) SaveToFile(path string) error

SaveToFile writes the Presentation out to a file.

func (*Presentation) SlideLayouts Uses

func (p *Presentation) SlideLayouts() []SlideLayout

SlideLayouts returns the slide layouts defined in the presentation.

func (*Presentation) SlideMasters Uses

func (p *Presentation) SlideMasters() []SlideMaster

SlideMasters returns the slide masters defined in the presentation.

func (*Presentation) Slides Uses

func (p *Presentation) Slides() []Slide

Slides returns the slides in the presentation.

func (*Presentation) Validate Uses

func (p *Presentation) Validate() error

func (*Presentation) X Uses

func (p *Presentation) X() *pml.Presentation

X returns the inner wrapped XML type.

type Slide Uses

type Slide struct {
    // contains filtered or unexported fields
}

func (Slide) AddImage Uses

func (s Slide) AddImage(img common.ImageRef) Image

AddImage adds an image textbox to a slide.

func (Slide) AddTextBox Uses

func (s Slide) AddTextBox() TextBox

AddTextBox adds an empty textbox to a slide.

func (Slide) GetPlaceholder Uses

func (s Slide) GetPlaceholder(t pml.ST_PlaceholderType) (PlaceHolder, error)

GetPlaceholder returns a placeholder given its type. If there are multiplace placeholders of the same type, this method returns the first one. You must use the PlaceHolders() method to access the others.

func (Slide) GetPlaceholderByIndex Uses

func (s Slide) GetPlaceholderByIndex(idx uint32) (PlaceHolder, error)

GetPlaceholderByIndex returns a placeholder given its index. If there are multiplace placeholders of the same index, this method returns the first one. You must use the PlaceHolders() method to access the others.

func (Slide) PlaceHolders Uses

func (s Slide) PlaceHolders() []PlaceHolder

PlaceHolders returns all of the content place holders within a given slide.

func (Slide) ValidateWithPath Uses

func (s Slide) ValidateWithPath(path string) error

ValidateWithPath validates the slide passing path informaton for a better error message

func (Slide) X Uses

func (s Slide) X() *pml.Sld

X returns the inner wrapped XML type.

type SlideLayout Uses

type SlideLayout struct {
    // contains filtered or unexported fields
}

SlideLayout

func (SlideLayout) Name Uses

func (s SlideLayout) Name() string

Name returns the name of the slide layout.

func (SlideLayout) Type Uses

func (s SlideLayout) Type() pml.ST_SlideLayoutType

Type returns the type of the slide layout.

func (SlideLayout) X Uses

func (s SlideLayout) X() *pml.SldLayout

X returns the inner wrapped XML type.

type SlideMaster Uses

type SlideMaster struct {
    // contains filtered or unexported fields
}

SlideMaster is the slide master for a presentation.

func (SlideMaster) SlideLayouts Uses

func (s SlideMaster) SlideLayouts() []SlideLayout

func (SlideMaster) X Uses

func (s SlideMaster) X() *pml.SldMaster

X returns the inner wrapped XML type.

type TextBox Uses

type TextBox struct {
    // contains filtered or unexported fields
}

TextBox is a text box within a slide.

func (TextBox) AddParagraph Uses

func (t TextBox) AddParagraph() drawing.Paragraph

AddParagraph adds a paragraph to the text box

func (TextBox) Properties Uses

func (t TextBox) Properties() drawing.ShapeProperties

Properties returns the properties of the TextBox.

func (TextBox) SetTextAnchor Uses

func (t TextBox) SetTextAnchor(a dml.ST_TextAnchoringType)

SetTextAnchor controls the text anchoring

Package presentation imports 23 packages (graph) and is imported by 2 packages. Updated 2019-05-05. Refresh now. Tools for package owners.