BodyProperties.HorizontalOverflow Property

Definition

Namespace:

DocumentFormat.OpenXml.Drawing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Text Horizontal Overflow

Represents the following attribute in the schema: horzOverflow

public DocumentFormat.OpenXml.EnumValue<DocumentFormat.OpenXml.Drawing.TextHorizontalOverflowValues>? HorizontalOverflow { get; set; }

member this.HorizontalOverflow : DocumentFormat.OpenXml.EnumValue<DocumentFormat.OpenXml.Drawing.TextHorizontalOverflowValues> with get, set

Public Property HorizontalOverflow As EnumValue(Of TextHorizontalOverflowValues)

Property Value

EnumValue<TextHorizontalOverflowValues>

Returns EnumValue<T>.

Remarks

The following information from the ECMA International Standard ECMA-376 can be useful when working with this class.

Determines whether the text can flow out of the bounding box horizontally. This is used to determine what will happen in the event that the text within a shape is too large for the bounding box it is contained within. If this attribute is omitted, then a value of overflow is implied.

Consider the case where we have multiply paragraphs within a shape and the second is greater in length and causes text to flow outside the shape. By applying the clip value of the horzOverflow attribute as a body property this overflowing text will now be cut off instead of extending beyond the bounds of the shape.

<p:txBody>  
  <a:bodyPr horzOverflow="clip" … />  
   …  
    <a:p>  
     …  
     (Some text)  
     …  
    </a:p>  
    <a:p>  
     …  
     (Some more text)  
     …  
    </a:p>  
</p:txBody>  

The possible values for this attribute are defined by the ST_TextHorzOverflowType simple type.