Hi everyone,
I’m using Words for Python via .NET, and came into an issue I cannot seem to solve.
I would need to check if the text in a text box is overflowing, and if so, reduce font size until all text fits. I cannot alter the text box dimensions whatsoever.
I did not see any methods or properties to check if text is overflowing, so I thought about the following method:
- Store the box dimensions
- Fit shape to text
- Compare old vs new dimensions. If they grew, it means there was overflow.
The issue is that the dimensions do not update after I apply fit_shape_to_text, but the shape is correctly enlarged to fit the text, so it definitely changes dimensions.
Ideally I need to know if the text in the box is overflowing, but if that’s not possible, at least know how to make the dimensions update after fitting the shape to the text.
Here’s a minimal example that I’m running on the attached doc.
doc.docx (16.4 KB)
import aspose.words as aw
from pathlib import Path
def autofit(shape: aw.drawing.Shape) -> aw.drawing.Shape:
shape.text_box.fit_shape_to_text = True
shape.text_box.text_box_wrap_mode = aw.drawing.TextBoxWrapMode.NONE
return shape
file = Path(r"doc.docx")
doc = aw.Document(file.name)
SHAPE = aw.NodeType.SHAPE
IS_DEEP = True
shapes = doc.get_child_nodes(SHAPE, IS_DEEP)
shape = shapes[0].as_shape() # I'm picking the first and only shape in my example doc
autofit(shape)
# The following attributes did not change after calling autofit(shape)
# even though if I save the document with doc.save(r"doc2.docx") to
# a new document I see the shape was resized.
#
# shape.height
# shape.width
# shape.coord_size.height
# shape.coord_size.width
# shape.bounds.x
# shape.bounds.y
# shape.top
# shape.bottom
# shape.left
# shape.right
doc.save(r"doc2.docx")
# The box was resized so evidently the text overflows and dimensions changed
# Nevertheless none of the parameters reflect that
Any help is greatly appreciated since I’ve navigated through the docs both for python via .net and .net itself, and I see no answer to my question. I’m at a total loss here.
Thanks in advance.
@saperez
To address the issue of checking for text overflow in a text box using Aspose.Words for Python via .NET, while ensuring that you do not alter the dimensions of the text box, you can follow these steps:
-
Store the Original Dimensions: Before fitting the shape to the text, save the original dimensions of the text box.
-
Fit Shape to Text: Use the fit_shape_to_text property to adjust the shape to fit the text.
-
Check for Overflow: After fitting the shape to the text, compare the original dimensions with the new dimensions. If the new dimensions are larger, it indicates that the text is overflowing.
However, you mentioned that the dimensions do not update after applying fit_shape_to_text, which is a known behavior. The shape visually adjusts to fit the text, but the properties you are checking (like shape.height, shape.width, etc.) may not reflect this change immediately.
Suggested Workaround
To determine if the text is overflowing without relying on the dimensions, you can implement a loop that reduces the font size until the text fits within the original dimensions. Here’s an example of how you might implement this:
import aspose.words as aw
from pathlib import Path
def adjust_font_size_to_fit(shape: aw.drawing.Shape, original_width: float, original_height: float):
# Start with the current font size
current_font_size = shape.text_box.text_frame.text_range.font.size
min_font_size = 6 # Set a minimum font size to avoid too small text
while True:
# Fit shape to text
shape.text_box.fit_shape_to_text = True
# Check if the dimensions exceed the original dimensions
if shape.width > original_width or shape.height > original_height:
# Reduce font size
current_font_size -= 1
if current_font_size < min_font_size:
break # Stop if minimum font size is reached
shape.text_box.text_frame.text_range.font.size = current_font_size
else:
break # Exit loop if text fits
file = Path(r"doc.docx")
doc = aw.Document(file.name)
SHAPE = aw.NodeType.SHAPE
IS_DEEP = True
shapes = doc.get_child_nodes(SHAPE, IS_DEEP)
shape = shapes[0].as_shape() # Assuming the first shape is your target
# Store original dimensions
original_width = shape.width
original_height = shape.height
# Adjust font size to fit text within the original dimensions
adjust_font_size_to_fit(shape, original_width, original_height)
doc.save(r"doc2.docx")
Explanation
- The
adjust_font_size_to_fit function reduces the font size until the text fits within the original dimensions of the text box.
- It uses a loop to continuously check the dimensions after fitting the shape to the text and adjusts the font size accordingly.
This approach allows you to manage text overflow without altering the text box dimensions directly.
If you have any further questions or need additional assistance, feel free to ask!
Sorry, but your answer is contradictory in every aspect:
You claim it is done without relying on the dimensions, but proceed to check against the original dimensions AND claim that it is done without altering the text box dimensions directly, yet the shape is set to fit the text.
Also by the way the answer is structured, and judging by your pfp, it seems it is a bot reply.
If that’s not the case, please do not take it personally, but this is not helpful at all.
Regards
@saperez TextBox.fit_shape_to_text flag determines whether Microsoft Word will grow the shape to fit text. Setting this property does not recalculate shape dimensions. This is done on the fly by the consumer application. You can try using LayoutCollector and LayoutEnumerator to calculate actual shape dimensions after setting this property.
doc = aw.Document("C:\\Temp\\in.docx")
s = doc.get_child(aw.NodeType.SHAPE, 0, True).as_shape()
print(f"widht: {s.width}; height: {s.height}");
s.text_box.fit_shape_to_text = True
s.text_box.text_box_wrap_mode = aw.drawing.TextBoxWrapMode.NONE
# Use LayoutCollector and LayoutEnumerator to get actual shape size after updating properties.
collector = aw.layout.LayoutCollector(doc)
enumerator = aw.layout.LayoutEnumerator(doc)
enumerator.set_current(collector, s)
print(f"widht: {enumerator.rectangle.width}; height: {enumerator.rectangle.height}");
doc.save("C:\\temp\\out.docx");
Thanks Alexey.
What I’m missing still is a way to change the box dimensions, specifically resize them back to the original dimensions.
Supposedly you can use s.width and s.height to both get AND set the dimensions, but setting them does not seem to have an effect.
Using enumerator.rectangle.width and enumerator.rectangle.height does not work to set it to new values.
An observation I’ve made is that shape.width and shape.height are the same on both the original and the enlarged boxes, even when opening from a doc that has a different text box size, i.e.
import aspose.words as aw
SHAPE = aw.NodeType.SHAPE
IS_DEEP = True
# _o = original
# _e = enlarged
doc_o = aw.Document("original.docx") # Original text box
shapes_o = doc_o.get_child_nodes(SHAPE, IS_DEEP)
s_o = shapes_o[0].as_shape()
collector_o = aw.layout.LayoutCollector(doc_o)
enumerator_o = aw.layout.LayoutEnumerator(doc_o)
enumerator_o.set_current(collector_o, s_o)
er_o = enumerator_o.rectangle
doc_e = aw.Document("enlarged.docx") # Document with box set to fit text
shapes_e = doc_e.get_child_nodes(SHAPE, IS_DEEP)
s_e = shapes_e[0].as_shape()
collector_e = aw.layout.LayoutCollector(doc_e)
enumerator_e = aw.layout.LayoutEnumerator(doc_e)
enumerator_e.set_current(collector_e, s_e)
er_e = enumerator_e.rectangle
# These evaluate to the same but shouldn't
s_o.width == s_e.width
s_o.height == s_e.height
So if there is no method/property to know if the text is overflowing, then I need a way to resize them back to the original size.
Thanks
@saperez Unfortunately, there is no direct way to determine whether content overflows the texbox. You can try using the following approach to check this and calculate font ratio to make the text box content fit:
doc = aw.Document("C:\\Temp\\in.docx")
s = doc.get_child(aw.NodeType.SHAPE, 0, True).as_shape()
# copy shape into a temporary document.
temp = doc.clone(False).as_document()
temp.ensure_minimum()
tmp_shape = temp.import_node(s, True, aw.ImportFormatMode.USE_DESTINATION_STYLES).as_shape()
temp.first_section.body.first_paragraph.append_child(tmp_shape)
tmp_shape.text_box.fit_shape_to_text = True
# Use LayoutCollector and LayoutEnumerator to get actual shape size after updating properties.
collector = aw.layout.LayoutCollector(temp)
enumerator = aw.layout.LayoutEnumerator(temp)
enumerator.set_current(collector, tmp_shape)
# Calculate font ratio to make the text box content fit
font_ratio = 1.0
while enumerator.rectangle.height > s.height and font_ratio > 0 :
font_ratio = font_ratio - 0.1
for p in tmp_shape.get_child_nodes(aw.NodeType.PARAGRAPH, True):
p = p.as_paragraph()
p.paragraph_break_font.size = p.paragraph_break_font.size * font_ratio
for r in p.runs:
r = r.as_run()
r.font.size = r.font.size * font_ratio
collector = aw.layout.LayoutCollector(temp)
enumerator = aw.layout.LayoutEnumerator(temp)
enumerator.set_current(collector, tmp_shape)
# scale the original text box content.
for p in s.get_child_nodes(aw.NodeType.PARAGRAPH, True):
p = p.as_paragraph()
p.paragraph_break_font.size = p.paragraph_break_font.size * font_ratio
for r in p.runs:
r = r.as_run()
r.font.size = r.font.size * font_ratio
doc.save("C:\\temp\\out.docx");
in.docx (16.6 KB)
out.docx (12.0 KB)