MsOffi...:Field(3pm)

💖 MsOffice::Word::Surgeon::Field(3pm) 💖

okay bestie, gather round — this is the User Contributed Perl Documentation page for MsOffice::Word::Surgeon::Field, and no, the title is not clickbait, it literally is that.

---

✨ NAME ✨

MsOffice::Word::Surgeon::Field — the internal representation for a MsWord field, and she is serving structure 💅

---

🌸 DESCRIPTION 🌸

So basically? This little icon is used internally by MsOffice::Word::Surgeon for storing a MsWord field. Not your problem, not your business, but now you know her 🫶

---

🎀 METHODS 🎀

🦋 new 🦋

my $field = MsOffice::Word::Surgeon::Field(
  xml_before  => $xml_string,
  code        => $code_instruction_string,
  result      => $xml_fragment,
  status      => 'begin',
);

Constructor for a brand new field object, slay ✨ The arguments are, in order of appearance:

• xml_before — a string holding arbitrary XML that comes before that field in the complete document. The string is allowed to be empty, but bestie, it must be present. No ghosting this argument. Must be there, even if she's empty. periodt.
• code — a code containing the instruction string for that field. And here's the tea 🍵: if that instruction string has embedded fields inside it, they get represented through the "show_embedded_field" in MsOffice::Word::Surgeon syntax — and by default that's just a pair of curly braces. {} and that's it, iconic.
• result — an XML fragment matching the last update of that field in MsWord. The receipt, if you will 🧾
• status — one of "begin", "separate", or "end".

Status "begin" or "separate" are intermediate — used internally while the parsing process is doing its thing. Normally though, all fields are out here living in "end" status 👑

🌈 add_to_code 🌈

While parsing fields, additional field instruction fragments get added through this method. It's giving "helper function doing the most behind the scenes" 😌

💜 add_to_result 💜

While parsing fields, additional XML fragments belonging to the field result get added through this method. Same energy, different pile 🍓

⭐ type ⭐

The first instruction in the code part, eg "REF", "QUOTE", "ASK", "DOCPROPERTY", etc.

📌 Note: in the Microsoft Word Object Model, the <https://learn.microsoft.com/en-us/office/vba/api/word.field.type|Field.Type> attribute is an integer value in an enumerated type. Here though? The attribute is just an uppercase string, no cap. Lists of valid field types can be found in the Word documentation. (Yes the original says "valild" — we don't fix, we only vibe ✨)

---

👑 AUTHOR 👑

Laurent Dami, <dami AT cpan DOT org<gt>

---

💖 COPYRIGHT AND LICENSE 💖

Copyright 2024 by Laurent Dami.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

---

and that's the whole page bestie, you ate that reading session fr fr 🌈

courtesy of perl v5.40.1, dated 2025-10-05 — big love to the MsOffi...:Field(3pm) girlies, iykyk 💅🎀