TextBox класс

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, содержащий свойства форматирования заливки для указанной фигуры.
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_ratioTrue означает, что изменение соотношения сторон запрещено.
rotation_angleПолучает и задает вращение фигуры.
hyperlinkПолучает гиперссылку фигуры.
idПолучает идентификатор этой фигуры.
spidУказывает необязательную строку, которую приложение может использовать для идентификации конкретной фигуры.
sptУказывает необязательный номер, который приложение может использовать для связи конкретной фигуры с определенным типом фигуры.
worksheetПолучает объект Shape.worksheet, содержащий эту фигуру.
is_groupУказывает, является ли фигура группой.
is_in_groupУказывает, сгруппирована ли фигура.
is_word_artУказывает, является ли эта фигура художественным текстом.
text_effectВозвращает объект TextEffectFormat, содержащий свойства форматирования текстового эффекта для указанной фигуры.
Применяется к объектам Shape, представляющим WordArt.
is_lockedTrue, если объект заблокирован, False, если объект можно изменить, когда лист защищен.
is_printableTrue, если объект можно распечатать
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Получает и устанавливает идентификатор для этой фигуры.

Методы

МетодОписание
to_imageСоздает изображение фигуры и сохраняет его в поток в указанном формате.
to_imageСохраняет форму в файл.
to_imageСохраняет форму в поток.
format_charactersФорматирует некоторые символы с помощью настройки шрифта.
format_charactersФорматирует некоторые символы с помощью настройки шрифта.
get_equation_paragraphПолучите указанный математический абзац из свойства TextBody объекта TextBox.
Уведомление:
(1) Возвращает NULL, если индекс выходит за пределы или не найден.
(2) Также возвращает NULL, если указанная позиция индекса не является математическим абзацем.
get_equation_paragraphПолучает первый математический абзац из свойства TextBody объекта TextBox.
get_result_of_smart_artПреобразование смарт-арта в сгруппированные фигуры.
to_front_or_backПеремещает фигуру на передний план или отодвигает ее назад.
get_locked_propertyПолучает значение заблокированного свойства.
set_locked_propertyУстановите заблокированное свойство.
add_hyperlinkДобавляет гиперссылку на фигуру.
remove_hyperlinkУдалите гиперссылку фигуры.
move_to_rangeПеремещает фигуру в указанный диапазон.
align_top_right_cornerПеремещает изображение в правый верхний угол.
get_connection_pointsПолучите точки подключения
get_linked_cellПолучает диапазон, связанный со значением элемента управления.
set_linked_cellУстанавливает диапазон, связанный со значением элемента управления.
get_input_rangeПолучает диапазон, используемый для заполнения элемента управления.
set_input_rangeУстанавливает диапазон, используемый для заполнения элемента управления.
update_selected_valueОбновите выбранное значение значением связанной ячейки.
calculate_text_sizeПересчитать текстовую область
charactersВозвращает объект символов, представляющий диапазон символов в тексте.
get_charactersВозвращает все объекты символов
который представляет собой диапазон символов в тексте.
get_rich_formattingsВозвращает все объекты символов
который представляет собой диапазон символов в тексте.
remove_active_x_controlУдалить элемент ActiveX.
is_same_settingВозвращает, одинакова ли форма.
get_actual_boxПолучите фактическое положение и размер фигуры (после применения поворота, переворота и т. д.).

Пример

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.0
# 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 класс