Main Content

mlreportgen.ppt.TextBox class

Package:mlreportgen.ppt

Text box

expand all in page

Description

Text box to include in a presentation.

Themlreportgen.ppt.TextBoxclass is ahandleclass.

Creation

Description

example

textBoxObj= TextBox()creates an empty text box object.

Properties

expand all

Option to use bold for text, specified astrueorfalse. To make text bold, set this property totrue

Font color, specified as a character vector. Use either a CSS color name or a hexadecimal RGB value.

  • For a list of CSS color names, seehttps://www.w3.org/wiki/CSS/Properties/color/keywords.

  • To specify a hexadecimal RGB format, use#as the first character and two-digit hexadecimal numbers for each for the red, green, and blue values. For example,'#0000ff'specifies blue.

Option to use italics for text, specified as a logical. Set this property totrue. Setting theItalicproperty adds a correspondingmlreportgen.ppt.Italicformat object to theStyleproperty of this presentation element. Removing theItalicproperty setting removes the object.

Data Types:logical

Type of underlining for text, specified as a character vector. Setting theUnderlineproperty adds a correspondingmlreportgen.ppt.Underlineformat object to theStyleproperty for this element. Removing theUnderlineproperty setting removes the object. You can specify one of these types of underlines.

Value Description
'single' Single underline
'double' Double underline
'heavy' Thick underline
'words' Words only underlined (not spaces)
“点” Dotted underline
'dottedheavy' Thick, dotted underline
'dash' Dashed underline
'dashheavy' Thick, dashed underline
'dashlong' Long, dashed underline
'dashlongheavy' Thick, long, dashed underline
'dotdash' Dot dash underline
'dotdotdash' Dot dot dash underline
'dotdotdashheavy' Thick dot dot dash underline
'dotdashdotheavy' Thick dash dot underline
'wavy' Wavy underline
'wavyheavy' Thick wavy underline
'wavydouble' Two wavy underlines

Text box name, specified as a character vector.

Upper-left x-coordinate position of text box, specified in the formvalueUnitswhereUnitsis an abbreviation for the units. Valid abbreviations are:

  • px— pixels (default)

  • cm— centimeters

  • in— inches

  • mm— millimeters

  • pc— picas

  • pt— points

Upper-left y-coordinate position of text box, specified in the formvalueUnitswhereUnitsis an abbreviation for the units. Valid abbreviations are:

  • px— pixels (default)

  • cm— centimeters

  • in— inches

  • mm— millimeters

  • pc— picas

  • pt— points

Width of text box, specified in the formvalueUnitswhereUnitsis an abbreviation for the units. Valid abbreviations are:

  • px— pixels (default)

  • cm— centimeters

  • in— inches

  • mm— millimeters

  • pc— picas

  • pt— points

Height of text box, specified in the formvalueUnitswhereUnitsis an abbreviation for the units. Valid abbreviations are:

  • px— pixels (default)

  • cm— centimeters

  • in— inches

  • mm— millimeters

  • pc— picas

  • pt— points

Text formatting, specified as a cell array of PPT format objects. You can specify thesemlreportgen.pptformat objects:

  • BackgroundColorobject

  • FontFamilyobject

  • FontSizeobject

  • Boldobject

  • FontColorobject

  • Italicobject

  • Underlineobject

Child elements of this object, specified as a cell array of PPT objects. This property is read-only.

Parent of this object, specified as a PPT object. This property is read-only.

Tag for this PPT API object, specified as a character vector or string scalar. A session-unique tag is generated as part of the creation of this object. The generated tag has the formCLASS:ID, whereCLASSis the object class andIDis the value of theIdproperty of the object.

Specifying your own tag value can help you to identify where an issue occurred during presentation generation.

ID for this PPT API object, specified as a character vector or string scalar. A session-unique ID is generated as part of object creation. You can specify an ID to replace the generated ID.

Methods

expand all

Examples

collapse all

Create a presentation with two slides.

importmlreportgen.ppt.*ppt = Presentation('myTextBoxPresentation.pptx');

Add a blank slide.

blank = add(ppt,'Blank');

Create a text box and define its location and size.

tb = TextBox(); tb.X ='1in'; tb.Y ='1in'; tb.Width ='8in'; tb.Height ='0.5in';

Add text to the text box and append the text box to the blank slide.

add(tb,'This is the title of my blank slide'); add(blank,tb);

Close and view the presentation.

close(ppt); rptview(ppt);

Here is the generated presentation:

版本History

Introduced in R2014b

See Also

||

Topics