ListBox класс

ListBox класс

Представляет собой объект списка.

Наследование: ListBox → Shape

Тип ListBox предоставляет следующие элементы:

Характеристики

Свойство	Описание
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-формат фигуры.
format_picture	Получает и задает параметры формата изображения.
is_hidden	Указывает, виден ли объект.
is_lock_aspect_ratio	True означает, что соотношение сторон фигуры зафиксировано.
is_aspect_ratio_locked	True означает, что соотношение сторон фигуры зафиксировано.
rotation_angle	Получает и задает поворот фигуры.
hyperlink	Получает гиперссылку формы.
id	Получает идентификатор этой формы.
spid	Указывает необязательный строковый идентификатор, который приложение может использовать для идентификации конкретной фигуры.
spt	Указывает необязательное число, которое приложение может использовать для связи конкретной фигуры с определенным типом фигуры.
worksheet	Получает объект Shape.worksheet, содержащий эту форму.
is_group	Указывает, является ли данная фигура групповой фигурой.
is_in_group	Указывает, сгруппирована ли фигура.
is_word_art	Указывает, является ли данная форма произведением искусства.
text_effect	Возвращает объект TextEffectFormat, содержащий свойства форматирования текста для указанной фигуры. Применяется к объектам Shape, представляющим WordArt.
is_locked	True означает, что объект не может быть изменен, если лист защищен. Обратите внимание, что это значение имеет смысл только в том случае, если рабочий лист или объекты на нем защищены.
is_printable	Указывает, можно ли распечатать объект. Если False, эта форма не будет напечатана при печати.
mso_drawing_type	Получает тип чертежа.
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	Возьмите реальный нижний ряд.
relative_to_original_picture_size	Указывает, соотносится ли форма с исходным размером изображения.
linked_cell	Возвращает или задает диапазон рабочего листа, связанный со значением элемента управления.
input_range	Возвращает или задает диапазон рабочего листа, используемый для заполнения указанного поля со списком.
text_shape_type	Получает и задает предустановленный тип формы текста.
text_body	Получает и задает настройки текста фигуры.
font	Представляет шрифт формы.
text_options	Представляет текстовые параметры фигуры.
text	Получает и задает текст этой фигуры.
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	Получает/задает направление потока текста для этого объекта.
text_box_options	Получает текстовую информацию в форме
control_data	Получает данные управления.
active_x_control	Получает элемент управления ActiveX.
paths	Получает пути произвольной геометрической формы.
create_id	Получает и задает идентификатор создания для этой формы.
is_decorative	Указывает, является ли объект декоративным.
item_count	Возвращает количество элементов в списке.
selected_index	Возвращает или задает порядковый номер текущего выбранного элемента в списке или раскрывающемся списке. Начинается с нуля.
selected_cells	Получает выбранные ячейки. Возвращает значение null, если диапазон ввода не задан или не выбран ни один элемент.
shadow	Указывает, имеет ли выпадающий список трехмерную заливку.
selection_type	Возвращает или задает режим выбора указанного списка.
page_change	Указывает величину, на которую изменяется значение элемента управления. когда пользователь нажимает на область полосы прокрутки «страница вверх» или «страница вниз».

Методы

Метод	Описание
to_image(self, stream, image_type)	Создает изображение фигуры и сохраняет его в потоке в указанном формате.
to_image(self, image_file, options)	Сохраняет форму в файле.
to_image(self, stream, options)	Сохраняет форму в потоке.
get_result_of_smart_art(self)	Преобразование интеллектуального искусства в сгруппированные фигуры.
to_front_or_back(self, orders)	Выводит фигуру на передний план или отодвигает её на задний план.
get_locked_property(self, type)	Получает значение заблокированного свойства.
set_locked_property(self, type, value)	Установить заблокированное свойство.
add_hyperlink(self, address)	Добавляет гиперссылку к форме.
remove_hyperlink(self)	Удаляет гиперссылку формы.
move_to_range(self, upper_left_row, upper_left_column, lower_right_row, lower_right_column)	Перемещает фигуру в указанный диапазон.
align_top_right_corner(self, top_row, right_column)	Перемещает картинку в правый верхний угол.
get_connection_points(self)	Получить точки подключения
get_linked_cell(self, is_r1c1, is_local)	Возвращает диапазон, связанный со значением элемента управления.
set_linked_cell(self, formula, is_r1c1, is_local)	Устанавливает диапазон, связанный со значением элемента управления.
get_input_range(self, is_r1c1, is_local)	Возвращает диапазон, используемый для заполнения элемента управления.
set_input_range(self, formula, is_r1c1, is_local)	Задает диапазон, используемый для заполнения элемента управления.
update_selected_value(self)	Обновить выбранное значение значением связанной ячейки.
calculate_text_size(self)	Пересчитать текстовую область
format_characters(self, start_index, length, font, flag)	Форматирует некоторые символы с помощью настроек шрифта.
characters(self, start_index, length)	Возвращает объект Characters, представляющий диапазон символов в тексте.
get_characters(self)	Возвращает все объекты Characters который представляет собой диапазон символов в тексте.
get_rich_formattings(self)	Возвращает все объекты Characters который представляет собой диапазон символов в тексте.
remove_active_x_control(self)	Удалить элемент управления ActiveX.
is_same_setting(self, obj)	Возвращает, одинакова ли форма.
get_actual_box(self)	Получить фактическое положение и размер фигуры (после применения поворота, отражения и т. д.)
fit_to_text_size(self)	Пересчитать текстовую область, подходящую для отображения всего текстового содержимого.
selected_item(self, item_index, is_selected)	Устанавливает, выбран ли элемент
is_selected(self, item_index)	Указывает, выбран ли элемент.

Пример

from aspose.cells import Workbook
from aspose.cells.drawing import PlacementType, SelectionType

# Create a new Workbook.
workbook = Workbook()
# Get the first worksheet.
sheet = workbook.worksheets[0]
# Get the worksheet cells collection.
cells = sheet.cells
# Input a value.
cells.get("B3").put_value("Choose Dept:")
# Set it bold.
style = cells.get("B3").get_style()
style.font.is_bold = True
cells.get("B3").set_style(style)
# Input some values that denote the input range
# for the list box.
cells.get("A2").put_value("Sales")
cells.get("A3").put_value("Finance")
cells.get("A4").put_value("MIS")
cells.get("A5").put_value("R&D")
cells.get("A6").put_value("Marketing")
cells.get("A7").put_value("HRA")
# Add a new list box.
listBox = sheet.shapes.add_list_box(2, 0, 3, 0, 122, 100)
# Set the placement type.
listBox.placement = PlacementType.FREE_FLOATING
# Set the linked cell.
listBox.linked_cell = "A1"
# Set the input range.
listBox.input_range = "A2:A7"
# Set the selection style.
listBox.selection_type = SelectionType.SINGLE
# Set the list box with 3-D shading.
listBox.shadow = True
# Saves the file.
workbook.save(r"tstlistbox.xls")

Смотрите также

• модуль aspose.cells.drawing
• класс GlowEffect
• класс ListBox
• класс ReflectionEffect
• класс ShadowEffect
• класс Shape