Struct Bookmark 

pub struct Bookmark {
    pub id: u32,
    pub name: String,
}

A named bookmark (w:bookmarkStart’s w:name, CT_Bookmark), attached to one or more runs via Run.bookmarks to mark which run(s) fall within its range. Hyperlink::Internal’s anchor name is meant to match a bookmark’s name here for the resulting link to actually go anywhere in Word — not validated when writing (same best-effort posture as Paragraph.numbering_id referencing a declaration that may not exist).

Fields

id: u32

This bookmark’s id (w:bookmarkStart/w:bookmarkEnd’s w:id), pairing a start with its matching end — purely an internal wiring detail, never referenced from outside the document (unlike name, which is what Hyperlink::Internal’s anchor actually points to).

name: String

This bookmark’s name (w:bookmarkStart’s w:name), what Hyperlink::Internal(name) refers to.

Implementations

impl Bookmark

pub fn new(id: u32, name: impl Into<String>) -> Bookmark

Creates a new bookmark with the given id and name. The id only needs to be unique among a paragraph’s currently-open bookmarks (mirroring comment_ids’s own uniqueness scope) — this crate does not track or validate uniqueness across the whole document.

Examples found in repository

examples/docx_navigation_and_annotations.rs (line 39)

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

    let document =
        Document::new()
            .with_paragraph(heading(
                "Hyperlinks: external, and internal to a bookmark",
                false,
            ))
            .with_paragraph(
                Paragraph::new()
                    .with_run(Run::new("Visit the ").with_hyperlink(Hyperlink::External(
                        "https://www.rust-lang.org".to_string(),
                    )))
                    .with_run(Run::new("or jump ").with_hyperlink(Hyperlink::External(
                        "https://www.rust-lang.org".to_string(),
                    )))
                    .with_run(
                        Run::new("down to the bookmark")
                            .with_hyperlink(Hyperlink::Internal("Target".to_string())),
                    ),
            )
            .with_paragraph(
                Paragraph::new()
                    .with_run(Run::new("Here is ").with_bookmark(Bookmark::new(0, "Target")))
                    .with_run(
                        Run::new("the bookmarked text.").with_bookmark(Bookmark::new(0, "Target")),
                    ),
            )
            .with_paragraph(heading("Comments", true))
            .with_paragraph(
                Paragraph::new()
                    .with_run(Run::new("This sentence "))
                    .with_run(Run::new("needs a second look").with_comment(0))
                    .with_run(Run::new(" before it ships.")),
            )
            .with_comment(
                Comment::with_text(0, "Please double-check this claim.")
                    .with_author("Reviewer")
                    .with_initials("RV"),
            )
            .with_paragraph(heading("Footnotes and endnotes", true))
            .with_paragraph(
                Paragraph::with_text("A claim that needs a footnote")
                    .with_run(Run::with_note_reference(NoteReference::Footnote(1)))
                    .with_run(Run::new(", and another that needs an endnote"))
                    .with_run(Run::with_note_reference(NoteReference::Endnote(1))),
            )
            .with_footnote(Note::footnote_with_text(
                1,
                "The footnote's own explanatory text.",
            ))
            .with_endnote(Note::endnote_with_text(
                1,
                "The endnote's own explanatory text.",
            ))
            .with_paragraph(heading("A structured document tag (content control)", true))
            .with_paragraph(Paragraph::with_text("Before the content control:"))
            .with_structured_document_tag(
                StructuredDocumentTag::new()
                    .with_id(42)
                    .with_tag("CustomerName")
                    .with_alias("Customer name")
                    .with_paragraph(Paragraph::with_text("Acme Corp.")),
            );

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

Trait Implementations

impl Clone for Bookmark

fn clone(&self) -> Bookmark

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bookmark

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

Formats the value using the given formatter.

impl Eq for Bookmark

impl PartialEq for Bookmark

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Bookmark