使用 OpenXML 在 Word 中获取复选框

Question

如何使用 OpenXML 获取嵌入到 Word 文档中的 CheckBox 控件的句柄？

您可能会认为 Paragraph.ControlPropertiesPart 或 Paragraph.Descendents() 会实现某些目标，但在每种情况下我都会返回 null 类型。

我可以使用实际的 XML 结构遍历文档树，但这看起来很麻烦。

欢迎提出建议。

Answer 1

下面的代码显示了如何枚举Word文档中的所有复选框
在文档主体上使用 Decendants() 方法。

using (WordprocessingDocument doc = WordprocessingDocument.Open("c:\\temp\\checkbox.docx", true))
{
  foreach (CheckBox cb in doc.MainDocumentPart.Document.Body.Descendants<CheckBox>())
  {
    Console.Out.WriteLine(cb.LocalName);

    FormFieldName cbName = cb.Parent.ChildElements.First<FormFieldName>();
    Console.Out.WriteLine(cbName.Val);

    DefaultCheckBoxFormFieldState defaultState = cb.GetFirstChild<DefaultCheckBoxFormFieldState>();
    Checked state = cb.GetFirstChild<Checked>();

    Console.Out.WriteLine(defaultState.Val.ToString());

    if (state.Val == null) // In case checkbox is checked the val attribute is null
    {
      Console.Out.WriteLine("CHECKED");
    }
    else
    {
      Console.Out.WriteLine(state.Val.ToString());
    }
  }
}

要确定给定复选框输入元素的名称，您必须访问
CheckBox 实例的 Parent 属性，然后搜索 FormFieldName 元素（要为复选框指定名称，请使用 Microsoft Word 中的“属性”对话框） 。

DefaultCheckBoxFormFieldState Val 属性保存复选框的默认状态。
此外，Checked 元素的 Val 属性保存实际的选中状态
CheckBox 实例的。请注意，对于 Microsoft Word 2007，如果满足以下条件，则 Val 属性为 null：
复选框被选中。

开始编辑

我想扩展我的答案。事实上，MS Word 开发人员选项卡上有两种复选框控件 - 传统复选框和 ActiveX 控件复选框。上面显示的代码可用于枚举 Word 文档中的旧复选框（请参阅此 有关如何创建旧复选框的文章）。

据我所知，您无法使用 OpenXML SDK 获取/设置 ActiveX 复选框的值。
不过，您可以使用以下代码枚举 ActiveX 控件：

foreach (Control ctrl in doc.MainDocumentPart.Document.Body.Descendants<Control>())
{
   Console.Out.WriteLine(ctrl.Id);
   Console.Out.WriteLine(ctrl.Name);
   Console.Out.WriteLine(ctrl.ShapeId);
}

要确定给定的 Control 是否为复选框，您必须检查 Control 的类 ID。复选框的类 ID 为 {8BD21D40-EC42-11CE-9E0D-00AA006002F3}。
这是一个获取类ID的代码示例（我不知道是否有更简单的方法...）：

OpenXmlPart part = doc.MainDocumentPart.GetPartById(ctrl.Id);
OpenXmlReader re = OpenXmlReader.Create(part.GetStream());
re.Read();
OpenXmlElement el = re.LoadCurrentElement();          
if(el.GetAttribute("classid", el.NamespaceUri).Value == "{8BD21D40-EC42-11CE-9E0D-00AA006002F3}")
{
  Console.WriteLine("Checkbox found...");
}
re.Close();

END EDIT

EDIT 2

我没有意识到Word 2010 中有一个新的复选框控件（感谢 Dennis
帕尔默）。

要枚举这些新的复选框控件，您可以使用以下代码：

using (WordprocessingDocument doc = WordprocessingDocument.Open(filename, true))
{
   MainDocumentPart mp = doc.MainDocumentPart;

   foreach(SdtContentCheckBox cb in mp.Document.Body.Descendants<SdtContentCheckBox>())
   {         
     if(cb.Checked.Val == "1");
     {
       Console.Out.WriteLine("CHECKED");  
     }           
   }
}

END EDIT 2

希望这会有所帮助。