Struct docx_rust::formatting::ParagraphProperty

pub struct ParagraphProperty<'a> {

    pub style_id: Option<ParagraphStyleId<'a>>,
    pub keep_next: Option<KeepNext>,
    pub keep_lines: Option<KeepLines>,
    pub page_break_before: Option<PageBreakBefore>,
    pub widow_control: Option<WidowControl>,
    pub numbering: Option<NumberingProperty>,
    pub suppress_line_numbers: Option<SuppressLineNumbers>,
    pub border: Option<Borders<'a>>,
    pub shading: Option<Shading<'a>>,
    pub suppress_auto_hyphens: Option<SuppressAutoHyphens>,
    pub kinsoku: Option<Kinsoku>,
    pub word_wrap: Option<WordWrap>,
    pub overflow_punct: Option<OverflowPunct>,
    pub top_line_punct: Option<TopLinePunct>,
    pub auto_space_de: Option<AutoSpaceDE>,
    pub auto_space_dn: Option<AutoSpaceDN>,
    pub bidi: Option<Bidi>,
    pub adjust_right_ind: Option<AdjustRightInd>,
    pub snap_to_grid: Option<SnapToGrid>,
    pub spacing: Option<Spacing>,
    pub indent: Option<Indent>,
    pub contextual_spacing: Option<ContextualSpacing>,
    pub mirror_indents: Option<MirrorIndents>,
    pub suppress_overlap: Option<SuppressOverlap>,
    pub justification: Option<Justification>,
    pub outline_lvl: Option<OutlineLvl>,
    pub div_id: Option<DivId>,
    pub cnf_style: Option<CnfStyle<'a>>,
    pub r_pr: Option<CharacterProperty<'a>>,
    pub section_property: Option<SectionProperty<'a>>,
}

Paragraph Property

use docx_rust::formatting::{ParagraphProperty, JustificationVal};

let prop = ParagraphProperty::default()
    .style_id("foo")
    .justification(JustificationVal::Start)
    .numbering((10usize, 20usize));

Fields

style_id: Option<ParagraphStyleId<'a>>

Specifies the style ID of the paragraph style.

keep_next: Option<KeepNext>

Keep Paragraph With Next Paragraph

keep_lines: Option<KeepLines>

Keep All Lines On One Page

page_break_before: Option<PageBreakBefore>

Start Paragraph on Next Page

widow_control: Option<WidowControl>

Text Frame Properties Allow First/Last Line to Display on a Separate Page Specifies whether enable widow control

numbering: Option<NumberingProperty>

Specifies that the paragraph should be numbered.

suppress_line_numbers: Option<SuppressLineNumbers>

Suppress Line Numbers for Paragraph

border: Option<Borders<'a>>

Specifies borders for the paragraph.

shading: Option<Shading<'a>>

Paragraph Shading

suppress_auto_hyphens: Option<SuppressAutoHyphens>

Set of Custom Tab Stops Suppress Hyphenation for Paragraph

kinsoku: Option<Kinsoku>

Use East Asian Typography Rules for First and Last Character per Line

word_wrap: Option<WordWrap>

Allow Line Breaking At Character Level

overflow_punct: Option<OverflowPunct>

Allow Punctuation to Extent Past Text Extents

top_line_punct: Option<TopLinePunct>

Compress Punctuation at Start of a Line

auto_space_de: Option<AutoSpaceDE>

Automatically Adjust Spacing of Latin and East Asian Text

auto_space_dn: Option<AutoSpaceDN>

Automatically Adjust Spacing of East Asian Text and Numbers

bidi: Option<Bidi>

Right to Left Paragraph Layout

adjust_right_ind: Option<AdjustRightInd>

Automatically Adjust Right Indent When Using Document Grid

snap_to_grid: Option<SnapToGrid>

Use Document Grid Settings for Inter-Line Paragraph Spacing

spacing: Option<Spacing>

Spacing Between Lines and Above/Below Paragraph

indent: Option<Indent>

Paragraph Indentation

contextual_spacing: Option<ContextualSpacing>

Ignore Spacing Above and Below When Using Identical Styles

mirror_indents: Option<MirrorIndents>

Use Left/Right Indents as Inside/Outside Indents

suppress_overlap: Option<SuppressOverlap>

Prevent Text Frames From Overlapping

justification: Option<Justification>

Paragraph Alignment

outline_lvl: Option<OutlineLvl>

Paragraph Text Flow Direction Vertical Character Alignment on Line Allow Surrounding Paragraphs to Tight Wrap to Text Box Contents Associated Outline Level

div_id: Option<DivId>

Associated HTML div ID

cnf_style: Option<CnfStyle<'a>>

Paragraph Conditional Formatting

r_pr: Option<CharacterProperty<'a>>

section_property: Option<SectionProperty<'a>>

Implementations

impl<'a> ParagraphProperty<'a>

pub fn style_id<T: Into<ParagraphStyleId<'a>>>(self, value: T) -> Self

pub fn justification<T: Into<Justification>>(self, value: T) -> Self

pub fn border<T: Into<Borders<'a>>>(self, value: T) -> Self

pub fn numbering<T: Into<NumberingProperty>>(self, value: T) -> Self

pub fn spacing<T: Into<Spacing>>(self, value: T) -> Self

pub fn indent<T: Into<Indent>>(self, value: T) -> Self

Trait Implementations

impl<'a> Clone for ParagraphProperty<'a>

fn clone(&self) -> ParagraphProperty<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ParagraphProperty<'a>

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

Formats the value using the given formatter.

impl<'a> Default for ParagraphProperty<'a>

fn default() -> ParagraphProperty<'a>

Returns the “default value” for a type.

impl<'__input: 'a, 'a> XmlRead<'__input> for ParagraphProperty<'a>

fn from_reader(reader: &mut XmlReader<'__input>) -> XmlResult<Self>

fn from_str(text: &'a str) -> Result<Self, XmlError>

impl<'a> XmlWrite for ParagraphProperty<'a>

fn to_writer<W: Write>(&self, writer: &mut XmlWriter<W>) -> XmlResult<()>

fn to_string(&self) -> Result<String, XmlError>