更改字处理文档的打印方向

项目
01/21/2025

本主题演示如何使用 Open XML SDK for Office 中的类以编程方式设置Microsoft Word文档的打印方向。它包含演示此任务的示例 SetPrintOrientation 方法。

SetPrintOrientation 方法

可以使用 SetPrintOrientation 方法更改字处理文档的打印方向。方法接受两个参数，这些参数指示要修改 (字符串) 的文档的名称，以及 (PageOrientationValues) 的新打印方向。

以下代码显示了 SetPrintOrientation 方法。

C#
Visual Basic

static void SetPrintOrientation(string fileName, string orientation)

Sub SetPrintOrientation(fileName As String, orientation As String)

对于文档中的每个部分，如果新的方向与该部分当前的打印方向不同，则该代码将修改该部分的打印方向。此外，该代码必须手动更新每个部分的宽度、高度和边距。

调用示例 SetPrintOrientation 方法

若要调用示例 SetPrintOrientation 方法，请传递包含要转换的文件的名称的字符串以及字符串“landscape”或“portrait”，具体取决于所需的方向。以下代码显示示例方法调用。

C#
Visual Basic

SetPrintOrientation(args[0], args[1]);

SetPrintOrientation(args(0), args(1))

代码的工作方式

以下代码首先确定要应用的方向，然后使用方法打开文档 Open ，并将参数设置为 isEditabletrue 以指示文档应可读/写。代码检索对 main 文档部件的引用，然后使用该引用检索文档内容中类型SectionProperties的所有后代的集合。稍后，代码将使用此集合轮流为每个部分设置方向。

C#
Visual Basic

PageOrientationValues newOrientation = orientation.ToLower() switch
{
    "landscape" => PageOrientationValues.Landscape,
    "portrait" => PageOrientationValues.Portrait,
    _ => throw new System.ArgumentException("Invalid argument: " + orientation)
};

using (var document = WordprocessingDocument.Open(fileName, true))
{
    if (document?.MainDocumentPart?.Document.Body is null)
    {
        throw new ArgumentNullException("MainDocumentPart and/or Body is null.");
    }

    Body docBody = document.MainDocumentPart.Document.Body;

    IEnumerable<SectionProperties> sections = docBody.ChildElements.OfType<SectionProperties>();

    if (sections.Count() == 0)
    {
        docBody.AddChild(new SectionProperties());

        sections = docBody.ChildElements.OfType<SectionProperties>();
    }

Dim newOrientation As PageOrientationValues

Select Case orientation.ToLower()
    Case "landscape"
        newOrientation = PageOrientationValues.Landscape
    Case "portrait"
        newOrientation = PageOrientationValues.Portrait
    Case Else
        Throw New ArgumentException("Invalid argument: " & orientation)
End Select


Using document As WordprocessingDocument = WordprocessingDocument.Open(fileName, True)
    If document?.MainDocumentPart?.Document.Body Is Nothing Then
        Throw New ArgumentNullException("MainDocumentPart and/or Body is null.")
    End If

    Dim docBody As Body = document.MainDocumentPart.Document.Body

    Dim sections As IEnumerable(Of SectionProperties) = docBody.ChildElements.OfType(Of SectionProperties)()

    If sections.Count() = 0 Then
        docBody.AddChild(New SectionProperties())

        sections = docBody.ChildElements.OfType(Of SectionProperties)()
    End If

循环访问所有部分

下一个代码块循环访问元素集合 SectionProperties 中的所有节。对于每个部分，该代码都将初始化一个用于跟踪该部分的页面方向是否已更改的变量，以便代码能够更新页面大小和边距。 (如果新方向与原始方向匹配，则代码不会更新页面。) 代码继续检索对元素第一 PageSize 个后代的 SectionProperties 引用。如果此引用不为空，则该代码将根据需要更新方向。

C#
Visual Basic

foreach (SectionProperties sectPr in sections)
{
    bool pageOrientationChanged = false;

    PageSize pgSz = sectPr.ChildElements.OfType<PageSize>().FirstOrDefault() ?? sectPr.AppendChild(new PageSize() { Width = 12240, Height = 15840 });

For Each sectPr As SectionProperties In sections
    Dim pageOrientationChanged As Boolean = False

    Dim pgSz As PageSize = If(sectPr.ChildElements.OfType(Of PageSize)().FirstOrDefault(), sectPr.AppendChild(New PageSize() With {.Width = 12240, .Height = 15840}))

设置部分的方向

下一个代码块首先检查元素的 PageSize 属性是否存在Orient。与 Open XML 元素的许多属性一样，属性或特性可能尚不存在。在这种情况下，检索属性将返回 null 引用。默认情况下，如果属性不存在，并且新方向为 Portrait，则代码不会更新页面。 Orient如果属性已存在，并且其值不同于作为参数提供给方法的新方向值，则代码将设置 Value 属性Orient的属性，并设置 pageOrientationChanged 标志。 (代码使用 pageOrientationChanged 标志来确定它是否必须更新页面大小和 margins。)

注意

如果代码必须创建 Orient 属性，则它还必须创建要在属性中存储的值，作为新 EnumValue<T> 实例，在构造函数中 EnumValue 提供新的方向。

C#
Visual Basic

if (pgSz.Orient is null)
{
    // Need to create the attribute. You do not need to
    // create the Orient property if the property does not
    // already exist, and you are setting it to Portrait.
    // That is the default value.
    if (newOrientation != PageOrientationValues.Portrait)
    {
        pageOrientationChanged = true;
        pgSz.Orient = new EnumValue<PageOrientationValues>(newOrientation);
    }
}
else
{
    // The Orient property exists, but its value
    // is different than the new value.
    if (pgSz.Orient.Value != newOrientation)
    {
        pgSz.Orient.Value = newOrientation;
        pageOrientationChanged = true;
    }

If pgSz.Orient Is Nothing Then
    ' Need to create the attribute. You do not need to 
    ' create the Orient property if the property does not 
    ' already exist, and you are setting it to Portrait. 
    ' That is the default value.
    If newOrientation <> PageOrientationValues.Portrait Then
        pageOrientationChanged = True
        pgSz.Orient = New EnumValue(Of PageOrientationValues)(newOrientation)
    End If
Else
    ' The Orient property exists, but its value
    ' is different than the new value.
    If pgSz.Orient.Value <> newOrientation Then
        pgSz.Orient.Value = newOrientation
        pageOrientationChanged = True
    End If
End If

更新页面大小

此时，在代码中，页面方向可能已更改。如果是这样，则代码必须完成另外两个任务。它必须更新页面大小，并更新分区的页边距。第一个任务很简单，以下代码仅交换页面高度和宽度，并将值存储在元素中 PageSize 。

C#
Visual Basic

if (pageOrientationChanged)
{
    // Changing the orientation is not enough. You must also
    // change the page size.
    var width = pgSz.Width;
    var height = pgSz.Height;
    pgSz.Width = height;
    pgSz.Height = width;

If pageOrientationChanged Then
    ' Changing the orientation is not enough. You must also 
    ' change the page size.
    Dim width = pgSz.Width
    Dim height = pgSz.Height
    pgSz.Width = height
    pgSz.Height = width

更新边距

本示例过程中的下一个步骤是处理该部分的边距。如果页面方向已更改，则该代码必须旋转边距以进行匹配。为此，代码检索对节的 PageMargin 元素的引用。如果该元素存在，该代码将旋转这些边距。请注意，该代码会将边距旋转 90 度 - 而一些打印机会将边距旋转 270 度，并且您可以修改代码来说明这一点。另请注意， Top 对象的和 Bottom 属性 PageMargin 是有符号值，和 Left Right 属性是无符号值。当该代码旋转边距设置时，它必须在这两类值之间转换，如下面的代码所示。

C#
Visual Basic

PageMargin? pgMar = sectPr.Descendants<PageMargin>().FirstOrDefault();

if (pgMar is not null)
{
    // Rotate margins. Printer settings control how far you
    // rotate when switching to landscape mode. Not having those
    // settings, this code rotates 90 degrees. You could easily
    // modify this behavior, or make it a parameter for the
    // procedure.
    if (pgMar.Top is null || pgMar.Bottom is null || pgMar.Left is null || pgMar.Right is null)
    {
        throw new ArgumentNullException("One or more of the PageMargin elements is null.");
    }

    var top = pgMar.Top.Value;
    var bottom = pgMar.Bottom.Value;
    var left = pgMar.Left.Value;
    var right = pgMar.Right.Value;

    pgMar.Top = new Int32Value((int)left);
    pgMar.Bottom = new Int32Value((int)right);
    pgMar.Left = new UInt32Value((uint)System.Math.Max(0, bottom));
    pgMar.Right = new UInt32Value((uint)System.Math.Max(0, top));
}

Dim pgMar As PageMargin = sectPr.Descendants(Of PageMargin)().FirstOrDefault()

If pgMar IsNot Nothing Then
    ' Rotate margins. Printer settings control how far you 
    ' rotate when switching to landscape mode. Not having those
    ' settings, this code rotates 90 degrees. You could easily
    ' modify this behavior, or make it a parameter for the 
    ' procedure.
    If pgMar.Top Is Nothing OrElse pgMar.Bottom Is Nothing OrElse pgMar.Left Is Nothing OrElse pgMar.Right Is Nothing Then
        Throw New ArgumentNullException("One or more of the PageMargin elements is null.")
    End If

    Dim top = pgMar.Top.Value
    Dim bottom = pgMar.Bottom.Value
    Dim left = pgMar.Left.Value
    Dim right = pgMar.Right.Value

    pgMar.Top = New Int32Value(CInt(left))
    pgMar.Bottom = New Int32Value(CInt(right))
    pgMar.Left = New UInt32Value(CUInt(System.Math.Max(0, bottom)))
    pgMar.Right = New UInt32Value(CUInt(System.Math.Max(0, top)))
End If

示例代码

下面是 C# 和 Visual Basic 中的完整 SetPrintOrientation 代码示例。

C#
Visual Basic

static void SetPrintOrientation(string fileName, string orientation)
{
    PageOrientationValues newOrientation = orientation.ToLower() switch
    {
        "landscape" => PageOrientationValues.Landscape,
        "portrait" => PageOrientationValues.Portrait,
        _ => throw new System.ArgumentException("Invalid argument: " + orientation)
    };

    using (var document = WordprocessingDocument.Open(fileName, true))
    {
        if (document?.MainDocumentPart?.Document.Body is null)
        {
            throw new ArgumentNullException("MainDocumentPart and/or Body is null.");
        }

        Body docBody = document.MainDocumentPart.Document.Body;

        IEnumerable<SectionProperties> sections = docBody.ChildElements.OfType<SectionProperties>();

        if (sections.Count() == 0)
        {
            docBody.AddChild(new SectionProperties());

            sections = docBody.ChildElements.OfType<SectionProperties>();
        }

        foreach (SectionProperties sectPr in sections)
        {
            bool pageOrientationChanged = false;

            PageSize pgSz = sectPr.ChildElements.OfType<PageSize>().FirstOrDefault() ?? sectPr.AppendChild(new PageSize() { Width = 12240, Height = 15840 });

            // No Orient property? Create it now. Otherwise, just
            // set its value. Assume that the default orientation  is Portrait.
            if (pgSz.Orient is null)
            {
                // Need to create the attribute. You do not need to
                // create the Orient property if the property does not
                // already exist, and you are setting it to Portrait.
                // That is the default value.
                if (newOrientation != PageOrientationValues.Portrait)
                {
                    pageOrientationChanged = true;
                    pgSz.Orient = new EnumValue<PageOrientationValues>(newOrientation);
                }
            }
            else
            {
                // The Orient property exists, but its value
                // is different than the new value.
                if (pgSz.Orient.Value != newOrientation)
                {
                    pgSz.Orient.Value = newOrientation;
                    pageOrientationChanged = true;
                }

                if (pageOrientationChanged)
                {
                    // Changing the orientation is not enough. You must also
                    // change the page size.
                    var width = pgSz.Width;
                    var height = pgSz.Height;
                    pgSz.Width = height;
                    pgSz.Height = width;

                    PageMargin? pgMar = sectPr.Descendants<PageMargin>().FirstOrDefault();

                    if (pgMar is not null)
                    {
                        // Rotate margins. Printer settings control how far you
                        // rotate when switching to landscape mode. Not having those
                        // settings, this code rotates 90 degrees. You could easily
                        // modify this behavior, or make it a parameter for the
                        // procedure.
                        if (pgMar.Top is null || pgMar.Bottom is null || pgMar.Left is null || pgMar.Right is null)
                        {
                            throw new ArgumentNullException("One or more of the PageMargin elements is null.");
                        }

                        var top = pgMar.Top.Value;
                        var bottom = pgMar.Bottom.Value;
                        var left = pgMar.Left.Value;
                        var right = pgMar.Right.Value;

                        pgMar.Top = new Int32Value((int)left);
                        pgMar.Bottom = new Int32Value((int)right);
                        pgMar.Left = new UInt32Value((uint)System.Math.Max(0, bottom));
                        pgMar.Right = new UInt32Value((uint)System.Math.Max(0, top));
                    }
                }
            }
        }
    }
}

Sub SetPrintOrientation(fileName As String, orientation As String)
    Dim newOrientation As PageOrientationValues

    Select Case orientation.ToLower()
        Case "landscape"
            newOrientation = PageOrientationValues.Landscape
        Case "portrait"
            newOrientation = PageOrientationValues.Portrait
        Case Else
            Throw New ArgumentException("Invalid argument: " & orientation)
    End Select


    Using document As WordprocessingDocument = WordprocessingDocument.Open(fileName, True)
        If document?.MainDocumentPart?.Document.Body Is Nothing Then
            Throw New ArgumentNullException("MainDocumentPart and/or Body is null.")
        End If

        Dim docBody As Body = document.MainDocumentPart.Document.Body

        Dim sections As IEnumerable(Of SectionProperties) = docBody.ChildElements.OfType(Of SectionProperties)()

        If sections.Count() = 0 Then
            docBody.AddChild(New SectionProperties())

            sections = docBody.ChildElements.OfType(Of SectionProperties)()
        End If

        For Each sectPr As SectionProperties In sections
            Dim pageOrientationChanged As Boolean = False

            Dim pgSz As PageSize = If(sectPr.ChildElements.OfType(Of PageSize)().FirstOrDefault(), sectPr.AppendChild(New PageSize() With {.Width = 12240, .Height = 15840}))

            ' No Orient property? Create it now. Otherwise, just 
            ' set its value. Assume that the default orientation  is Portrait.
            If pgSz.Orient Is Nothing Then
                ' Need to create the attribute. You do not need to 
                ' create the Orient property if the property does not 
                ' already exist, and you are setting it to Portrait. 
                ' That is the default value.
                If newOrientation <> PageOrientationValues.Portrait Then
                    pageOrientationChanged = True
                    pgSz.Orient = New EnumValue(Of PageOrientationValues)(newOrientation)
                End If
            Else
                ' The Orient property exists, but its value
                ' is different than the new value.
                If pgSz.Orient.Value <> newOrientation Then
                    pgSz.Orient.Value = newOrientation
                    pageOrientationChanged = True
                End If
            End If

            If pageOrientationChanged Then
                ' Changing the orientation is not enough. You must also 
                ' change the page size.
                Dim width = pgSz.Width
                Dim height = pgSz.Height
                pgSz.Width = height
                pgSz.Height = width

                Dim pgMar As PageMargin = sectPr.Descendants(Of PageMargin)().FirstOrDefault()

                If pgMar IsNot Nothing Then
                    ' Rotate margins. Printer settings control how far you 
                    ' rotate when switching to landscape mode. Not having those
                    ' settings, this code rotates 90 degrees. You could easily
                    ' modify this behavior, or make it a parameter for the 
                    ' procedure.
                    If pgMar.Top Is Nothing OrElse pgMar.Bottom Is Nothing OrElse pgMar.Left Is Nothing OrElse pgMar.Right Is Nothing Then
                        Throw New ArgumentNullException("One or more of the PageMargin elements is null.")
                    End If

                    Dim top = pgMar.Top.Value
                    Dim bottom = pgMar.Bottom.Value
                    Dim left = pgMar.Left.Value
                    Dim right = pgMar.Right.Value

                    pgMar.Top = New Int32Value(CInt(left))
                    pgMar.Bottom = New Int32Value(CInt(right))
                    pgMar.Left = New UInt32Value(CUInt(System.Math.Max(0, bottom)))
                    pgMar.Right = New UInt32Value(CUInt(System.Math.Max(0, top)))
                End If
            End If
        Next
    End Using
End Sub

另请参阅

Open XML SDK 类库参考

通过