Struct TextRunProperties 

pub struct TextRunProperties {
    pub bold: bool,
    pub italic: bool,
    pub underline: Option<TextUnderline>,
    pub strike: Option<TextStrike>,
    pub fill: Option<Fill>,
    pub font_size_100ths_point: Option<i32>,
    pub font_family: Option<String>,
    pub hyperlink: Option<Hyperlink>,
    pub baseline_1000ths_percent: Option<i32>,
    pub highlight: Option<Color>,
    pub text_caps: Option<TextCaps>,
    pub character_spacing_100ths_point: Option<i32>,
}

A run’s character formatting (<a:rPr>/<a:defRPr>/<a:endParaRPr>, CT_TextCharacterProperties) — this crate only ever writes/reads it as <a:rPr> (on <a:r>/<a:br>), not the other two contexts.

Not modeled: lang/altLang (spell-check locale), kern/normalizeH (kerning threshold, auto-condensing East Asian punctuation — narrow cosmetic refinements; spc/cap are modeled, see TextRunProperties::character_spacing_100ths_point/TextRunProperties::text_caps; baseline/highlight are also modeled, see TextRunProperties::baseline_1000ths_percent/TextRunProperties::highlight), hlinkMouseOver (a separate, rarely-authored hover-only link — only hlinkClick is modeled, see Hyperlink), underline’s own independent line/fill overrides (EG_TextUnderlineLine/ Fill — u’s color here always follows the text’s own fill, matching most real-world usage), and ea/cs/sym (East Asian/complex-script/ symbol font overrides — latin alone is modeled, same “one font, not a per-script set” simplification word-ooxml::Run::font_family already makes).

Fields

bold: bool

b (<a:rPr b="1">).

italic: bool

i.

underline: Option<TextUnderline>

u.

strike: Option<TextStrike>

strike.

fill: Option<Fill>

EG_FillProperties — the run’s text color (or gradient/pattern/ image, though a flat Fill::Solid color covers the overwhelming majority of real documents). Reuses Fill directly rather than a narrower color-only field, since the schema itself allows the full fill choice here, not just <a:solidFill>.

font_size_100ths_point: Option<i32>

sz, in hundredths of a point (ST_TextFontSize, 100.=400000 — i.e. 1pt to 4,000pt).

font_family: Option<String>

<a:latin typeface=".."> — the run’s font family/typeface, e.g. "Calibri". Mirrors word-ooxml::Run::font_family by name for cross-crate consistency (same real-world concept).

hyperlink: Option<Hyperlink>

<a:hlinkClick r:id=".."> (CT_Hyperlink, point 3) — a clickable hyperlink on this run. See Hyperlink’s own doc comment for why this carries an already-resolved relationship id rather than a raw URL.

baseline_1000ths_percent: Option<i32>

baseline (ST_Percentage, thousandths of a percent) — raises (positive) or lowers (negative) the run’s glyphs relative to the baseline, real PowerPoint’s own superscript/subscript mechanism (its UI writes 30000 for superscript, -25000 for subscript). None omits the attribute (no offset). Grounded against a real fixture exercising both signs.

highlight: Option<Color>

<a:highlight>{color}</a:highlight> — the run’s text-highlight color (like a highlighter pen), distinct from fill, which colors the glyphs themselves. None omits the element (no highlight). Grounded against a real fixture.

text_caps: Option<TextCaps>

cap (ST_TextCapsType) — forces the run’s glyphs to render as small caps or all caps, independent of the text actually typed (unlike literally typing uppercase letters, the underlying text stays whatever case it was entered in). None omits the attribute (no forced case). Grounded against a real fixture’s slide text (cap="none", PowerPoint’s own explicit “no caps override” — distinct from omitting the attribute, though both render identically).

character_spacing_100ths_point: Option<i32>

spc (ST_TextSpacingPoint, hundredths of a, may be negative to tighten spacing) — extra space inserted between characters. None omits the attribute (no adjustment). Grounded against a real fixture (spc="70", 0.7pt extra tracking).

Implementations

impl TextRunProperties

pub fn new() -> TextRunProperties

Examples found in repository

examples/pptx_theme_and_metadata.rs (line 71)

fn main() -> office_toolkit::Result<()> {
    // A custom theme and an embedded font. `Theme`/`ColorScheme`/
    // `FontScheme` have no `with_*` builders in this crate — only
    // `office_default()` or plain struct literals.
    let custom_theme = Theme {
        name: "Custom Brand".to_string(),
        colors: ColorScheme {
            dark1: "1B1B1B".to_string(),
            light1: "FFFFFF".to_string(),
            dark2: "0A2540".to_string(),
            light2: "F5F5F5".to_string(),
            accent1: "0A2540".to_string(),
            accent2: "E8622C".to_string(),
            accent3: "2E86AB".to_string(),
            accent4: "6FB98F".to_string(),
            accent5: "F4A259".to_string(),
            accent6: "8E4585".to_string(),
            hyperlink: "1155CC".to_string(),
            followed_hyperlink: "6B3FA0".to_string(),
        },
        fonts: FontScheme {
            major_latin: "Georgia".to_string(),
            minor_latin: "Verdana".to_string(),
        },
    };

    // Placeholder bytes — a real .pptx would carry genuine TrueType/
    // OpenType font data here.
    let embedded_font = EmbeddedFont::new("Custom Sans")
        .with_regular(vec![0u8; 16])
        .with_bold(vec![0u8; 16]);

    // A slide with no shapes at all renders as a blank page — nothing shows
    // the custom theme actually took effect. `drawing::Color` has no
    // scheme-relative variant yet (`<a:schemeClr>` isn't modeled, see that
    // enum's own doc comment), so this can't reference the theme's accent1
    // symbolically; it uses the same literal hex values the theme itself
    // was built from, purely so the slide visibly matches the palette above.
    let title_shape = AutoShape::new(2, "Title")
        .with_properties(
            ShapeProperties::new()
                .with_transform(
                    Transform2D::new()
                        .with_offset(838_200, 838_200)
                        .with_extent(6_000_000, 1_500_000),
                )
                .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.accent1.clone()))),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new().with_run(TextRun::text_with_properties(
                    "Custom Brand theme — Georgia / Verdana, accent1 = #0A2540",
                    TextRunProperties::new()
                        .with_font_family(custom_theme.fonts.major_latin.clone())
                        .with_font_size_points(24.0)
                        .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.light1.clone()))),
                )),
            ),
        );

    let themed_presentation = Presentation::new()
        .with_theme(custom_theme)
        .with_embedded_font(embedded_font)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(title_shape)));
    let theme_path = output_path("pptx_theme.pptx");
    themed_presentation.save_to_file(&theme_path)?;
    println!("Wrote {}", theme_path.display());

    // Document metadata (docProps/core.xml, app.xml, and custom.xml).
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Presentation-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("PPTX-META".to_string()),
        );
    // Same reasoning as `title_shape` above: an empty slide would render
    // blank, so a text shape spells out where the metadata actually lives.
    let metadata_shape = AutoShape::new(2, "Note")
        .with_properties(ShapeProperties::new().with_transform(Transform2D::new().with_offset(838_200, 838_200).with_extent(7_000_000, 1_000_000)))
        .with_text_body(TextBody::new().with_paragraph(TextParagraph::new().with_run(TextRun::text(
            "This presentation's metadata is in File > Info (title, author, subject, and a custom \"ProjectCode\" property) — not on this slide.",
        ))));
    let metadata_presentation = Presentation::new()
        .with_properties(properties)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(metadata_shape)));
    let metadata_path = output_path("pptx_metadata.pptx");
    metadata_presentation.save_to_file(&metadata_path)?;
    println!("Wrote {}", metadata_path.display());

    Ok(())
}

examples/pptx_text_formatting.rs (line 111)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("pptx_text_formatting.pptx");

    let spacing_shape = AutoShape::new(2, "Spacing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_properties(
                        TextParagraphProperties::new()
                            .with_line_spacing(TextSpacing::Percent(150_000))
                            .with_space_before(TextSpacing::Points(1200))
                            .with_indent_emu(457_200)
                            .with_level(1),
                    )
                    .with_run(TextRun::text(
                        "Indented, 150% line spacing, 12pt space before.",
                    )),
            ),
        );

    let bullets_shape = AutoShape::new(2, "Bullets")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_800_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(
                            TextParagraphProperties::new()
                                .with_bullet(BulletKind::Character("\u{2022}".to_string())),
                        )
                        .with_run(TextRun::text("Bulleted item")),
                )
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(TextParagraphProperties::new().with_bullet(
                            BulletKind::AutoNumber {
                                scheme: "arabicPeriod".to_string(),
                                start_at: None,
                            },
                        ))
                        .with_run(TextRun::text("Auto-numbered item")),
                ),
        );

    let autofit_shape = AutoShape::new(2, "Autofit")
        .with_text_box(true)
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(4_000_000, 1_000_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_properties(
                    TextBodyProperties::new()
                        .with_autofit(TextAutofit::Shape)
                        .with_anchor(TextAnchor::Center)
                        .with_anchor_center(true),
                )
                .with_paragraph(TextParagraph::new().with_run(TextRun::text(
                    "This shape resizes to fit its text, centered both ways.",
                ))),
        );

    let casing_shape = AutoShape::new(2, "Casing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text_with_properties(
                        "rendered in all caps, ",
                        TextRunProperties::new().with_text_caps(TextCaps::All),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "widely spaced, ",
                        TextRunProperties::new().with_character_spacing_points(3.0),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "highlighted",
                        TextRunProperties::new().with_highlight(Color::Rgb("FFFF00".to_string())),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "2",
                        TextRunProperties::new().with_baseline_percent(30.0),
                    )),
            ),
        );

    let field_shape = AutoShape::new(2, "Field")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(3_000_000, 500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text("Slide "))
                    .with_run(TextRun::field(
                        "{7A9E3F10-4B6C-4D2E-9A1F-8C5D6E7F0123}",
                        Some("slidenum".to_string()),
                        "1",
                    )),
            ),
        );

    let presentation = Presentation::new()
        .with_slide(Slide::new().with_shape(Shape::AutoShape(spacing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(bullets_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(autofit_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(casing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(field_shape)));

    presentation.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_bold(self, bold: bool) -> TextRunProperties

pub fn with_italic(self, italic: bool) -> TextRunProperties

pub fn with_underline(self, underline: TextUnderline) -> TextRunProperties

pub fn with_strike(self, strike: TextStrike) -> TextRunProperties

pub fn with_fill(self, fill: Fill) -> TextRunProperties

Examples found in repository

examples/pptx_theme_and_metadata.rs (line 74)

fn main() -> office_toolkit::Result<()> {
    // A custom theme and an embedded font. `Theme`/`ColorScheme`/
    // `FontScheme` have no `with_*` builders in this crate — only
    // `office_default()` or plain struct literals.
    let custom_theme = Theme {
        name: "Custom Brand".to_string(),
        colors: ColorScheme {
            dark1: "1B1B1B".to_string(),
            light1: "FFFFFF".to_string(),
            dark2: "0A2540".to_string(),
            light2: "F5F5F5".to_string(),
            accent1: "0A2540".to_string(),
            accent2: "E8622C".to_string(),
            accent3: "2E86AB".to_string(),
            accent4: "6FB98F".to_string(),
            accent5: "F4A259".to_string(),
            accent6: "8E4585".to_string(),
            hyperlink: "1155CC".to_string(),
            followed_hyperlink: "6B3FA0".to_string(),
        },
        fonts: FontScheme {
            major_latin: "Georgia".to_string(),
            minor_latin: "Verdana".to_string(),
        },
    };

    // Placeholder bytes — a real .pptx would carry genuine TrueType/
    // OpenType font data here.
    let embedded_font = EmbeddedFont::new("Custom Sans")
        .with_regular(vec![0u8; 16])
        .with_bold(vec![0u8; 16]);

    // A slide with no shapes at all renders as a blank page — nothing shows
    // the custom theme actually took effect. `drawing::Color` has no
    // scheme-relative variant yet (`<a:schemeClr>` isn't modeled, see that
    // enum's own doc comment), so this can't reference the theme's accent1
    // symbolically; it uses the same literal hex values the theme itself
    // was built from, purely so the slide visibly matches the palette above.
    let title_shape = AutoShape::new(2, "Title")
        .with_properties(
            ShapeProperties::new()
                .with_transform(
                    Transform2D::new()
                        .with_offset(838_200, 838_200)
                        .with_extent(6_000_000, 1_500_000),
                )
                .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.accent1.clone()))),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new().with_run(TextRun::text_with_properties(
                    "Custom Brand theme — Georgia / Verdana, accent1 = #0A2540",
                    TextRunProperties::new()
                        .with_font_family(custom_theme.fonts.major_latin.clone())
                        .with_font_size_points(24.0)
                        .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.light1.clone()))),
                )),
            ),
        );

    let themed_presentation = Presentation::new()
        .with_theme(custom_theme)
        .with_embedded_font(embedded_font)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(title_shape)));
    let theme_path = output_path("pptx_theme.pptx");
    themed_presentation.save_to_file(&theme_path)?;
    println!("Wrote {}", theme_path.display());

    // Document metadata (docProps/core.xml, app.xml, and custom.xml).
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Presentation-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("PPTX-META".to_string()),
        );
    // Same reasoning as `title_shape` above: an empty slide would render
    // blank, so a text shape spells out where the metadata actually lives.
    let metadata_shape = AutoShape::new(2, "Note")
        .with_properties(ShapeProperties::new().with_transform(Transform2D::new().with_offset(838_200, 838_200).with_extent(7_000_000, 1_000_000)))
        .with_text_body(TextBody::new().with_paragraph(TextParagraph::new().with_run(TextRun::text(
            "This presentation's metadata is in File > Info (title, author, subject, and a custom \"ProjectCode\" property) — not on this slide.",
        ))));
    let metadata_presentation = Presentation::new()
        .with_properties(properties)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(metadata_shape)));
    let metadata_path = output_path("pptx_metadata.pptx");
    metadata_presentation.save_to_file(&metadata_path)?;
    println!("Wrote {}", metadata_path.display());

    Ok(())
}

pub fn with_font_size_points(self, points: f64) -> TextRunProperties

Sets the font size, given in ordinary points (converted to the schema’s hundredths-of-a-point unit internally).

Examples found in repository

examples/pptx_theme_and_metadata.rs (line 73)

fn main() -> office_toolkit::Result<()> {
    // A custom theme and an embedded font. `Theme`/`ColorScheme`/
    // `FontScheme` have no `with_*` builders in this crate — only
    // `office_default()` or plain struct literals.
    let custom_theme = Theme {
        name: "Custom Brand".to_string(),
        colors: ColorScheme {
            dark1: "1B1B1B".to_string(),
            light1: "FFFFFF".to_string(),
            dark2: "0A2540".to_string(),
            light2: "F5F5F5".to_string(),
            accent1: "0A2540".to_string(),
            accent2: "E8622C".to_string(),
            accent3: "2E86AB".to_string(),
            accent4: "6FB98F".to_string(),
            accent5: "F4A259".to_string(),
            accent6: "8E4585".to_string(),
            hyperlink: "1155CC".to_string(),
            followed_hyperlink: "6B3FA0".to_string(),
        },
        fonts: FontScheme {
            major_latin: "Georgia".to_string(),
            minor_latin: "Verdana".to_string(),
        },
    };

    // Placeholder bytes — a real .pptx would carry genuine TrueType/
    // OpenType font data here.
    let embedded_font = EmbeddedFont::new("Custom Sans")
        .with_regular(vec![0u8; 16])
        .with_bold(vec![0u8; 16]);

    // A slide with no shapes at all renders as a blank page — nothing shows
    // the custom theme actually took effect. `drawing::Color` has no
    // scheme-relative variant yet (`<a:schemeClr>` isn't modeled, see that
    // enum's own doc comment), so this can't reference the theme's accent1
    // symbolically; it uses the same literal hex values the theme itself
    // was built from, purely so the slide visibly matches the palette above.
    let title_shape = AutoShape::new(2, "Title")
        .with_properties(
            ShapeProperties::new()
                .with_transform(
                    Transform2D::new()
                        .with_offset(838_200, 838_200)
                        .with_extent(6_000_000, 1_500_000),
                )
                .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.accent1.clone()))),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new().with_run(TextRun::text_with_properties(
                    "Custom Brand theme — Georgia / Verdana, accent1 = #0A2540",
                    TextRunProperties::new()
                        .with_font_family(custom_theme.fonts.major_latin.clone())
                        .with_font_size_points(24.0)
                        .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.light1.clone()))),
                )),
            ),
        );

    let themed_presentation = Presentation::new()
        .with_theme(custom_theme)
        .with_embedded_font(embedded_font)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(title_shape)));
    let theme_path = output_path("pptx_theme.pptx");
    themed_presentation.save_to_file(&theme_path)?;
    println!("Wrote {}", theme_path.display());

    // Document metadata (docProps/core.xml, app.xml, and custom.xml).
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Presentation-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("PPTX-META".to_string()),
        );
    // Same reasoning as `title_shape` above: an empty slide would render
    // blank, so a text shape spells out where the metadata actually lives.
    let metadata_shape = AutoShape::new(2, "Note")
        .with_properties(ShapeProperties::new().with_transform(Transform2D::new().with_offset(838_200, 838_200).with_extent(7_000_000, 1_000_000)))
        .with_text_body(TextBody::new().with_paragraph(TextParagraph::new().with_run(TextRun::text(
            "This presentation's metadata is in File > Info (title, author, subject, and a custom \"ProjectCode\" property) — not on this slide.",
        ))));
    let metadata_presentation = Presentation::new()
        .with_properties(properties)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(metadata_shape)));
    let metadata_path = output_path("pptx_metadata.pptx");
    metadata_presentation.save_to_file(&metadata_path)?;
    println!("Wrote {}", metadata_path.display());

    Ok(())
}

pub fn with_font_family( self, font_family: impl Into<String>, ) -> TextRunProperties

Examples found in repository

examples/pptx_theme_and_metadata.rs (line 72)

fn main() -> office_toolkit::Result<()> {
    // A custom theme and an embedded font. `Theme`/`ColorScheme`/
    // `FontScheme` have no `with_*` builders in this crate — only
    // `office_default()` or plain struct literals.
    let custom_theme = Theme {
        name: "Custom Brand".to_string(),
        colors: ColorScheme {
            dark1: "1B1B1B".to_string(),
            light1: "FFFFFF".to_string(),
            dark2: "0A2540".to_string(),
            light2: "F5F5F5".to_string(),
            accent1: "0A2540".to_string(),
            accent2: "E8622C".to_string(),
            accent3: "2E86AB".to_string(),
            accent4: "6FB98F".to_string(),
            accent5: "F4A259".to_string(),
            accent6: "8E4585".to_string(),
            hyperlink: "1155CC".to_string(),
            followed_hyperlink: "6B3FA0".to_string(),
        },
        fonts: FontScheme {
            major_latin: "Georgia".to_string(),
            minor_latin: "Verdana".to_string(),
        },
    };

    // Placeholder bytes — a real .pptx would carry genuine TrueType/
    // OpenType font data here.
    let embedded_font = EmbeddedFont::new("Custom Sans")
        .with_regular(vec![0u8; 16])
        .with_bold(vec![0u8; 16]);

    // A slide with no shapes at all renders as a blank page — nothing shows
    // the custom theme actually took effect. `drawing::Color` has no
    // scheme-relative variant yet (`<a:schemeClr>` isn't modeled, see that
    // enum's own doc comment), so this can't reference the theme's accent1
    // symbolically; it uses the same literal hex values the theme itself
    // was built from, purely so the slide visibly matches the palette above.
    let title_shape = AutoShape::new(2, "Title")
        .with_properties(
            ShapeProperties::new()
                .with_transform(
                    Transform2D::new()
                        .with_offset(838_200, 838_200)
                        .with_extent(6_000_000, 1_500_000),
                )
                .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.accent1.clone()))),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new().with_run(TextRun::text_with_properties(
                    "Custom Brand theme — Georgia / Verdana, accent1 = #0A2540",
                    TextRunProperties::new()
                        .with_font_family(custom_theme.fonts.major_latin.clone())
                        .with_font_size_points(24.0)
                        .with_fill(Fill::Solid(Color::Rgb(custom_theme.colors.light1.clone()))),
                )),
            ),
        );

    let themed_presentation = Presentation::new()
        .with_theme(custom_theme)
        .with_embedded_font(embedded_font)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(title_shape)));
    let theme_path = output_path("pptx_theme.pptx");
    themed_presentation.save_to_file(&theme_path)?;
    println!("Wrote {}", theme_path.display());

    // Document metadata (docProps/core.xml, app.xml, and custom.xml).
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Presentation-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("PPTX-META".to_string()),
        );
    // Same reasoning as `title_shape` above: an empty slide would render
    // blank, so a text shape spells out where the metadata actually lives.
    let metadata_shape = AutoShape::new(2, "Note")
        .with_properties(ShapeProperties::new().with_transform(Transform2D::new().with_offset(838_200, 838_200).with_extent(7_000_000, 1_000_000)))
        .with_text_body(TextBody::new().with_paragraph(TextParagraph::new().with_run(TextRun::text(
            "This presentation's metadata is in File > Info (title, author, subject, and a custom \"ProjectCode\" property) — not on this slide.",
        ))));
    let metadata_presentation = Presentation::new()
        .with_properties(properties)
        .with_slide(Slide::new().with_shape(Shape::AutoShape(metadata_shape)));
    let metadata_path = output_path("pptx_metadata.pptx");
    metadata_presentation.save_to_file(&metadata_path)?;
    println!("Wrote {}", metadata_path.display());

    Ok(())
}

pub fn with_hyperlink(self, hyperlink: Hyperlink) -> TextRunProperties

Attaches a hyperlink to this run.

pub fn with_baseline_percent(self, percent: f64) -> TextRunProperties

Sets the run’s baseline offset (superscript/subscript), given as an ordinary percentage (e.g. 30.0 for real PowerPoint’s own superscript, -25.0 for its subscript).

Examples found in repository

examples/pptx_text_formatting.rs (line 123)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("pptx_text_formatting.pptx");

    let spacing_shape = AutoShape::new(2, "Spacing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_properties(
                        TextParagraphProperties::new()
                            .with_line_spacing(TextSpacing::Percent(150_000))
                            .with_space_before(TextSpacing::Points(1200))
                            .with_indent_emu(457_200)
                            .with_level(1),
                    )
                    .with_run(TextRun::text(
                        "Indented, 150% line spacing, 12pt space before.",
                    )),
            ),
        );

    let bullets_shape = AutoShape::new(2, "Bullets")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_800_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(
                            TextParagraphProperties::new()
                                .with_bullet(BulletKind::Character("\u{2022}".to_string())),
                        )
                        .with_run(TextRun::text("Bulleted item")),
                )
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(TextParagraphProperties::new().with_bullet(
                            BulletKind::AutoNumber {
                                scheme: "arabicPeriod".to_string(),
                                start_at: None,
                            },
                        ))
                        .with_run(TextRun::text("Auto-numbered item")),
                ),
        );

    let autofit_shape = AutoShape::new(2, "Autofit")
        .with_text_box(true)
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(4_000_000, 1_000_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_properties(
                    TextBodyProperties::new()
                        .with_autofit(TextAutofit::Shape)
                        .with_anchor(TextAnchor::Center)
                        .with_anchor_center(true),
                )
                .with_paragraph(TextParagraph::new().with_run(TextRun::text(
                    "This shape resizes to fit its text, centered both ways.",
                ))),
        );

    let casing_shape = AutoShape::new(2, "Casing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text_with_properties(
                        "rendered in all caps, ",
                        TextRunProperties::new().with_text_caps(TextCaps::All),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "widely spaced, ",
                        TextRunProperties::new().with_character_spacing_points(3.0),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "highlighted",
                        TextRunProperties::new().with_highlight(Color::Rgb("FFFF00".to_string())),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "2",
                        TextRunProperties::new().with_baseline_percent(30.0),
                    )),
            ),
        );

    let field_shape = AutoShape::new(2, "Field")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(3_000_000, 500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text("Slide "))
                    .with_run(TextRun::field(
                        "{7A9E3F10-4B6C-4D2E-9A1F-8C5D6E7F0123}",
                        Some("slidenum".to_string()),
                        "1",
                    )),
            ),
        );

    let presentation = Presentation::new()
        .with_slide(Slide::new().with_shape(Shape::AutoShape(spacing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(bullets_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(autofit_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(casing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(field_shape)));

    presentation.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_highlight(self, color: Color) -> TextRunProperties

Sets the run’s text-highlight color.

Examples found in repository

examples/pptx_text_formatting.rs (line 119)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("pptx_text_formatting.pptx");

    let spacing_shape = AutoShape::new(2, "Spacing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_properties(
                        TextParagraphProperties::new()
                            .with_line_spacing(TextSpacing::Percent(150_000))
                            .with_space_before(TextSpacing::Points(1200))
                            .with_indent_emu(457_200)
                            .with_level(1),
                    )
                    .with_run(TextRun::text(
                        "Indented, 150% line spacing, 12pt space before.",
                    )),
            ),
        );

    let bullets_shape = AutoShape::new(2, "Bullets")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_800_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(
                            TextParagraphProperties::new()
                                .with_bullet(BulletKind::Character("\u{2022}".to_string())),
                        )
                        .with_run(TextRun::text("Bulleted item")),
                )
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(TextParagraphProperties::new().with_bullet(
                            BulletKind::AutoNumber {
                                scheme: "arabicPeriod".to_string(),
                                start_at: None,
                            },
                        ))
                        .with_run(TextRun::text("Auto-numbered item")),
                ),
        );

    let autofit_shape = AutoShape::new(2, "Autofit")
        .with_text_box(true)
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(4_000_000, 1_000_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_properties(
                    TextBodyProperties::new()
                        .with_autofit(TextAutofit::Shape)
                        .with_anchor(TextAnchor::Center)
                        .with_anchor_center(true),
                )
                .with_paragraph(TextParagraph::new().with_run(TextRun::text(
                    "This shape resizes to fit its text, centered both ways.",
                ))),
        );

    let casing_shape = AutoShape::new(2, "Casing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text_with_properties(
                        "rendered in all caps, ",
                        TextRunProperties::new().with_text_caps(TextCaps::All),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "widely spaced, ",
                        TextRunProperties::new().with_character_spacing_points(3.0),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "highlighted",
                        TextRunProperties::new().with_highlight(Color::Rgb("FFFF00".to_string())),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "2",
                        TextRunProperties::new().with_baseline_percent(30.0),
                    )),
            ),
        );

    let field_shape = AutoShape::new(2, "Field")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(3_000_000, 500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text("Slide "))
                    .with_run(TextRun::field(
                        "{7A9E3F10-4B6C-4D2E-9A1F-8C5D6E7F0123}",
                        Some("slidenum".to_string()),
                        "1",
                    )),
            ),
        );

    let presentation = Presentation::new()
        .with_slide(Slide::new().with_shape(Shape::AutoShape(spacing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(bullets_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(autofit_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(casing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(field_shape)));

    presentation.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_text_caps(self, caps: TextCaps) -> TextRunProperties

Sets the run’s forced letter case (small caps/all caps).

Examples found in repository

examples/pptx_text_formatting.rs (line 111)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("pptx_text_formatting.pptx");

    let spacing_shape = AutoShape::new(2, "Spacing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_properties(
                        TextParagraphProperties::new()
                            .with_line_spacing(TextSpacing::Percent(150_000))
                            .with_space_before(TextSpacing::Points(1200))
                            .with_indent_emu(457_200)
                            .with_level(1),
                    )
                    .with_run(TextRun::text(
                        "Indented, 150% line spacing, 12pt space before.",
                    )),
            ),
        );

    let bullets_shape = AutoShape::new(2, "Bullets")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_800_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(
                            TextParagraphProperties::new()
                                .with_bullet(BulletKind::Character("\u{2022}".to_string())),
                        )
                        .with_run(TextRun::text("Bulleted item")),
                )
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(TextParagraphProperties::new().with_bullet(
                            BulletKind::AutoNumber {
                                scheme: "arabicPeriod".to_string(),
                                start_at: None,
                            },
                        ))
                        .with_run(TextRun::text("Auto-numbered item")),
                ),
        );

    let autofit_shape = AutoShape::new(2, "Autofit")
        .with_text_box(true)
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(4_000_000, 1_000_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_properties(
                    TextBodyProperties::new()
                        .with_autofit(TextAutofit::Shape)
                        .with_anchor(TextAnchor::Center)
                        .with_anchor_center(true),
                )
                .with_paragraph(TextParagraph::new().with_run(TextRun::text(
                    "This shape resizes to fit its text, centered both ways.",
                ))),
        );

    let casing_shape = AutoShape::new(2, "Casing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text_with_properties(
                        "rendered in all caps, ",
                        TextRunProperties::new().with_text_caps(TextCaps::All),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "widely spaced, ",
                        TextRunProperties::new().with_character_spacing_points(3.0),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "highlighted",
                        TextRunProperties::new().with_highlight(Color::Rgb("FFFF00".to_string())),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "2",
                        TextRunProperties::new().with_baseline_percent(30.0),
                    )),
            ),
        );

    let field_shape = AutoShape::new(2, "Field")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(3_000_000, 500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text("Slide "))
                    .with_run(TextRun::field(
                        "{7A9E3F10-4B6C-4D2E-9A1F-8C5D6E7F0123}",
                        Some("slidenum".to_string()),
                        "1",
                    )),
            ),
        );

    let presentation = Presentation::new()
        .with_slide(Slide::new().with_shape(Shape::AutoShape(spacing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(bullets_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(autofit_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(casing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(field_shape)));

    presentation.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_character_spacing_points(self, points: f64) -> TextRunProperties

Sets the run’s extra inter-character spacing, given in ordinary points (converted to the schema’s hundredths-of-a-point unit internally; negative tightens spacing).

Examples found in repository

examples/pptx_text_formatting.rs (line 115)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("pptx_text_formatting.pptx");

    let spacing_shape = AutoShape::new(2, "Spacing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_properties(
                        TextParagraphProperties::new()
                            .with_line_spacing(TextSpacing::Percent(150_000))
                            .with_space_before(TextSpacing::Points(1200))
                            .with_indent_emu(457_200)
                            .with_level(1),
                    )
                    .with_run(TextRun::text(
                        "Indented, 150% line spacing, 12pt space before.",
                    )),
            ),
        );

    let bullets_shape = AutoShape::new(2, "Bullets")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_800_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(
                            TextParagraphProperties::new()
                                .with_bullet(BulletKind::Character("\u{2022}".to_string())),
                        )
                        .with_run(TextRun::text("Bulleted item")),
                )
                .with_paragraph(
                    TextParagraph::new()
                        .with_properties(TextParagraphProperties::new().with_bullet(
                            BulletKind::AutoNumber {
                                scheme: "arabicPeriod".to_string(),
                                start_at: None,
                            },
                        ))
                        .with_run(TextRun::text("Auto-numbered item")),
                ),
        );

    let autofit_shape = AutoShape::new(2, "Autofit")
        .with_text_box(true)
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(4_000_000, 1_000_000),
            ),
        )
        .with_text_body(
            TextBody::new()
                .with_properties(
                    TextBodyProperties::new()
                        .with_autofit(TextAutofit::Shape)
                        .with_anchor(TextAnchor::Center)
                        .with_anchor_center(true),
                )
                .with_paragraph(TextParagraph::new().with_run(TextRun::text(
                    "This shape resizes to fit its text, centered both ways.",
                ))),
        );

    let casing_shape = AutoShape::new(2, "Casing")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(6_000_000, 1_500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text_with_properties(
                        "rendered in all caps, ",
                        TextRunProperties::new().with_text_caps(TextCaps::All),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "widely spaced, ",
                        TextRunProperties::new().with_character_spacing_points(3.0),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "highlighted",
                        TextRunProperties::new().with_highlight(Color::Rgb("FFFF00".to_string())),
                    ))
                    .with_run(TextRun::text_with_properties(
                        "2",
                        TextRunProperties::new().with_baseline_percent(30.0),
                    )),
            ),
        );

    let field_shape = AutoShape::new(2, "Field")
        .with_properties(
            ShapeProperties::new().with_transform(
                Transform2D::new()
                    .with_offset(838_200, 838_200)
                    .with_extent(3_000_000, 500_000),
            ),
        )
        .with_text_body(
            TextBody::new().with_paragraph(
                TextParagraph::new()
                    .with_run(TextRun::text("Slide "))
                    .with_run(TextRun::field(
                        "{7A9E3F10-4B6C-4D2E-9A1F-8C5D6E7F0123}",
                        Some("slidenum".to_string()),
                        "1",
                    )),
            ),
        );

    let presentation = Presentation::new()
        .with_slide(Slide::new().with_shape(Shape::AutoShape(spacing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(bullets_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(autofit_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(casing_shape)))
        .with_slide(Slide::new().with_shape(Shape::AutoShape(field_shape)));

    presentation.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

Trait Implementations

impl Clone for TextRunProperties

fn clone(&self) -> TextRunProperties

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextRunProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for TextRunProperties

fn default() -> TextRunProperties

Returns the “default value” for a type.

impl PartialEq for TextRunProperties

fn eq(&self, other: &TextRunProperties) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TextRunProperties