TextBox类

封装表示电子表格中的文本框的对象。

继承： TextBox → Shape

TextBox 类型公开了以下成员：

特性

属性	描述
macro_name	获取和设置宏的名称。
is_equation	指示形状是否仅包含方程。
is_smart_art	指示形状是否为智能艺术。
z_order_position	返回形状在 z 顺序中的位置。
name	获取和设置形状的名称。
alternative_text	返回或设置 Shape 对象的描述性（替代）文本字符串。
title	指定当前形状对象的标题（标题）。
line_format	返回包含指定形状的线条格式属性的 MsoLineFormat 对象。
fill_format	返回包含指定形状的填充格式属性的 MsoFillFormat 对象。
format	表示形状格式设置。
line	获取线型
fill	返回包含指定形状的填充格式属性的 Shape.fill_format 对象。
shadow_effect	表示指定图表元素或形状的阴影效果的 ShadowEffect 对象。
reflection	表示指定图表元素或形状的反射效果的 ReflectionEffect 对象。
glow	表示指定图表元素或形状的发光效果的 GlowEffect 对象。
soft_edges	以点为单位获取和设置应用于边缘的模糊半径。
three_d_format	获取和设置形状的 3d 格式。
text_frame	返回包含指定形状的对齐和锚定属性的 TextFrame 对象。
format_picture	获取和设置图片格式选项。
is_hidden	指示对象是否可见。
is_lock_aspect_ratio	True 表示不允许更改纵横比。
rotation_angle	获取和设置形状的旋转。
hyperlink	获取形状的超链接。
id	获取此形状的标识符。
spid	指定应用程序可用于识别特定形状的可选字符串。
spt	指定一个可选数字，应用程序可以使用该数字将特定形状与定义的形状类型相关联。
worksheet	获取包含此形状的 Shape.worksheet 对象。
is_group	指示形状是否为组。
is_in_group	指示形状是否分组。
is_word_art	指示此形状是否为艺术字。
text_effect	返回包含指定形状的文本效果格式化属性的 TextEffectFormat 对象。适用于表示艺术字的 Shape 对象。
is_locked	如果对象被锁定，则为 True；如果工作表受保护时可以修改对象，则为 False。
is_printable	如果对象可打印则为真
mso_drawing_type	获取 mso 绘图类型。
auto_shape_type	获取和设置自动形状类型。
anchor_type	获取和设置形状锚点占位符。
placement	表示绘图对象附加到其下方单元格的方式。该属性控制对象在工作表上的位置。
upper_left_row	表示左上角的行索引。
upper_delta_y	获取或设置形状与其左上角行的垂直偏移量。
upper_left_column	表示左上角的列索引。
upper_delta_x	获取或设置形状与其左上角列的水平偏移量。
lower_right_row	表示右下角的行索引。
lower_delta_y	获取或设置形状与其右下角行的垂直偏移量。
lower_right_column	代表右下角的列索引。
lower_delta_x	获取或设置形状与其右下角列的水平偏移量。
right	表示形状从其右下角列的水平偏移的宽度，以像素为单位。
bottom	表示形状从其下底角行的垂直偏移的宽度，以像素为单位。
width	表示形状的宽度，以像素为单位。
width_inch	表示形状的宽度，以英寸为单位。
width_pt	表示形状的宽度，以磅为单位。
width_cm	表示形状的宽度，以厘米为单位。
height	表示形状的高度，以像素为单位。
height_inch	表示形状的高度，以英寸为单位。
height_pt	表示形状的高度，以磅为单位。
height_cm	表示形状的高度，以厘米为单位。
left	表示形状与其左列的水平偏移量，以像素为单位。
left_inch	表示形状与其左列的水平偏移量，以英寸为单位。
left_cm	表示形状与其左列的水平偏移量，以厘米为单位。
top	表示形状与其顶行的垂直偏移量，以像素为单位。
top_inch	表示形状与其顶行的垂直偏移量，以英寸为单位。
top_cm	表示形状与其顶行的垂直偏移量，以厘米为单位。
top_to_corner	获取和设置形状相对于工作表上边框的垂直偏移量，以像素为单位。
left_to_corner	获取和设置形状相对于工作表左边框的水平偏移量。
x	获取和设置形状相对于工作表左边框的水平偏移量，以像素为单位。
y	获取和设置形状相对于工作表上边框的垂直偏移量，以像素为单位。
width_scale	获取和设置宽度比例，单位为原始图片宽度的百分比。如果形状不是图片，WidthScale 属性只返回 100；
height_scale	获取和设置高度比例，单位为原始图片高度的百分比。如果形状不是图片，HeightScale 属性只返回 100；
top_in_shape	表示形状相对于父形状上边框的垂直偏移量，以父图形高度的 1/4000 为单位。
left_in_shape	表示形状相对于父形状左边框的水平偏移量，以父图形宽度的 1/4000 为单位。
width_in_shape	表示形状的宽度，以父形状的 1/4000 为单位。
height_in_shape	表示形状相对于父形状上边框的垂直偏移量，以父形状高度的 1/4000 为单位。
group	获取包含此形状的组形状。
type	获取自动形状类型。
has_line	获取和设置形状的线条边框是否可见。
is_filled	指示填充格式是否可见。
is_flipped_horizontally	获取和设置形状是否水平翻转。
is_flipped_vertically	获取和设置形状是否垂直翻转。
actual_lower_right_row	获取实际的底行。
connection_points	获取连接点
relative_to_original_picture_size	指示形状是否相对于原始图片大小。
linked_cell	获取或设置链接到控件值的工作表范围。
input_range	获取或设置用于填充指定组合框的工作表范围。
text_shape_type	获取和设置预设文本形状类型。
text_body	获取和设置形状文本的设置。
font	表示形状的字体。
text_options	表示形状的文本选项。
text	表示此 TextBox 对象中的字符串。
is_rich_text	文本是否为富文本。
html_text	获取和设置此文本框中包含数据和某些格式的 html 字符串。
text_vertical_overflow	获取和设置包含文本的形状的文本垂直溢出类型。
text_horizontal_overflow	获取和设置包含文本的形状的文本水平溢出类型。
is_text_wrapped	获取和设置包含文本的形状的文本环绕类型。
text_orientation_type	获取和设置形状的文本方向类型。
text_horizontal_alignment	获取和设置形状的文本水平对齐类型。
text_vertical_alignment	获取和设置形状的文本垂直对齐类型。
text_direction	获取/设置此对象的文本流方向。
control_data	获取控件的数据。
active_x_control	获取 ActiveX 控件。
paths	获取自定义几何形状的路径。
geometry	获取几何体
create_id	获取和设置此形状的创建 ID。

方法

方法	描述
to_image(stream, image_type)	创建形状图像并将其保存到指定格式的流中。
to_image(image_file, options)	将形状保存到文件中。
to_image(stream, options)	将形状保存到流中。
format_characters(start_index, length, font, flag)	使用字体设置格式化一些字符。
format_characters(start_index, length, font)	使用字体设置格式化一些字符。
get_result_of_smart_art()	将智能艺术转换为分组形状。
to_front_or_back(orders)	将形状带到前面或将形状发送到后面。
get_locked_property(type)	获取锁定属性的值。
set_locked_property(type, value)	设置锁定属性。
add_hyperlink(address)	向形状添加超链接。
remove_hyperlink()	删除形状的超链接。
move_to_range(upper_left_row, upper_left_column, lower_right_row, lower_right_column)	将形状移动到指定范围。
align_top_right_corner(top_row, right_column)	将图片移动到右上角。
get_connection_points()	获取连接点
get_linked_cell(is_r1c1, is_local)	获取链接到控件值的范围。
set_linked_cell(formula, is_r1c1, is_local)	设置链接到控件值的范围。
get_input_range(is_r1c1, is_local)	获取用于填充控件的范围。
set_input_range(formula, is_r1c1, is_local)	设置用于填充控件的范围。
update_selected_value()	通过链接单元格的值更新所选值。
calculate_text_size()	重新计算文本区域
characters(start_index, length)	返回一个 Characters 对象，该对象表示文本中的一系列字符。
get_characters()	返回所有字符对象表示文本中的一系列字符。
remove_active_x_control()	删除 activeX 控件。
is_same_setting(obj)	返回形状是否相同。

例子

from aspose.cells import Workbook
from aspose.cells.drawing import MsoLineDashStyle, MsoLineStyle, PlacementType
from aspose.pydrawing import Color

# Instantiate a new Workbook.
workbook = Workbook()
# Get the first worksheet in the book.
worksheet = workbook.worksheets[0]
# Add a new textbox to the collection.
textboxIndex = worksheet.text_boxes.add(2, 1, 160, 200)
# Get the textbox object.
textbox0 = worksheet.text_boxes[textboxIndex]
# Fill the text.
textbox0.text = "ASPOSE______The .NET and JAVA Component Publisher!"
# Set the textbox to adjust it according to its contents.
textbox0.text_body.text_alignment.auto_size = True
# Set the placement.
textbox0.placement = PlacementType.FREE_FLOATING
# Set the font color.
textbox0.font.color = Color.blue
# Set the font to bold.
textbox0.font.is_bold = True
# Set the font size.
textbox0.font.size = 14
# Set font attribute to italic.
textbox0.font.is_italic = True
# Add a hyperlink to the textbox.
textbox0.add_hyperlink("http://www.aspose.com/")
# Get the filformat of the textbox.
fillformat = textbox0.fill
# Set the fillcolor.
fillformat.solid_fill.color = Color.silver
# Get the lineformat type of the textbox.
lineformat = textbox0.line
# Set the line style.
lineformat.compound_type = MsoLineStyle.THIN_THICK
# Set the line weight.
lineformat.weight = 6
# Set the dash style to squaredot.
lineformat.dash_style = MsoLineDashStyle.SQUARE_DOT
# Add another textbox.
textboxIndex = worksheet.text_boxes.add(15, 4, 85, 120)
# Get the second textbox.
textbox1 = worksheet.text_boxes[textboxIndex]
# Input some text to it.
textbox1.text = "This is another simple text box"
# Set the placement type as the textbox will move and
# resize with cells.
textbox1.placement = PlacementType.MOVE_AND_SIZE
# Save the excel file.
workbook.save("tsttextboxes.xlsx")

也可以看看

Spinner类 TextBoxCollection类