exponenta event banner

класс mlreportgen.dom.StyleRef

Пакет: mlreportgen.dom
Суперклассы:

Местозаполнитель для ссылки на содержимое с указанным именем стиля или уровнем структуры

Описание

Создайте местозаполнитель для ссылки на содержимое с указанным именем стиля или уровнем структуры. Этот объект применяется к отчетам Word и PDF.

Для документа Microsoft ® Word можно добавить StyleRef объект в верхний колонтитул, нижний колонтитул или в основной текст. Для PDF можно добавить StyleRef объект только для верхнего или нижнего колонтитула.

Совет

Использовать StyleRef объекты для создания текущих колонтитулов в документе. Например, этот объект можно использовать для добавления заголовка текущей главы в заголовок страницы.

Строительство

styleref = StyleRef() создает ссылку на содержимое абзаца, ближайшего к данному объекту, OutlineLevel имущество 1.

В заголовках вывода Word ближайшим абзацем является первый абзац на текущей странице с указанным уровнем структуры. Если такой абзац на текущей странице отсутствует, ближайший абзац является первым абзацем на страницах до или после текущей страницы, которая имеет указанный уровень структуры.

В нижних колонтитулах вывода Word ближайшим абзацем является последний абзац на текущей странице с указанным уровнем структуры. Если такой абзац на текущей странице отсутствует, ближайший абзац является первым абзацем на страницах до или после текущей страницы, которая имеет указанный уровень структуры.

В заголовках и колонтитулах страниц, выводимых в формате PDF, ближайший абзац является первым абзацем на текущей странице или на страницах в разделе макета текущей страницы до или после текущей страницы.

styleref = StyleRef(num) создает ссылку на содержимое абзаца, ближайшего к данному объекту, OutlineLevel свойство имеет указанный уровень.

styleref = StyleRef(styleName) создает ссылку на содержимое ближайшего к этому объекту абзаца с указанным именем стиля.

Входные аргументы

развернуть все

Уровень ссылочного объекта заголовка, заданный как положительное целое число.

Имя стиля объекта для ссылки, указанное как символьный вектор.

Выходные аргументы

развернуть все

Объект ссылки, возвращенный как mlreportgen.dom.StyleRef объект.

Свойства

развернуть все

Дочерние элементы этого элемента документа, указанные как массив объектов DOM. Это свойство доступно только для чтения.

Пользовательские атрибуты этого элемента, указанные как массив mlreportgen.dom.CustomAttribute объекты. Используйте пользовательские атрибуты, поддерживаемые форматом вывода.

Идентификатор для этого элемента документа, указанный как вектор символов или скаляр строки. При создании элемента документа DOM создает уникальный идентификатор сеанса. Можно указать собственный идентификатор.

Стиль таблицы стилей, применяемый к ссылке, заданный как вектор символов.

Родительский элемент этого документа, указанный как объект DOM. Это свойство доступно только для чтения.

Форматирование объектов, задающих формат элемента документа.

Имя стиля, применяемого из таблицы стилей, определяемого как символьный вектор.

Тег для этого элемента документа, заданный как вектор символов или скаляр строки.

DOM создает уникальный для сеанса тег как часть создания этого объекта. Созданный тег имеет вид CLASS: ID, где CLASS - класс объекта, а ID - значение Id свойства объекта. Указание собственного значения тега может помочь определить, где возникла проблема во время создания документа.

Методы

Метод

Цель

clone

Копировать этот объект.

Примеры

свернуть все

В этом примере для задания содержимого нижнего колонтитула используется уровень структуры.

import mlreportgen.dom.*;
d = Document('mydoc','pdf');
open(d);

% Create page footer
footer = PDFPageFooter('default');
d.CurrentPageLayout.PageFooters = footer;

% Define and the StyleRef object using default (first level heading)
% Append it to the footer
ref = StyleRef();
append(footer,ref);

% Create several pages
% The footer content changes based on the last Heading1 object
h = Heading1('My First Head');
p = Paragraph('The above heading appears in the footer because it is a level 1 head.');
append(d,h);
append(d,p);

h2 = Heading1('My Next Head');
h2.Style = {PageBreakBefore(true)};
p2 = Paragraph('Now the above heading appears in the footer.');

append(d,h2);
append(d,p2);

h3 = Heading1('My Third Head');
h3.Style = {PageBreakBefore(true)};
append(d,h3);
append(d,clone(p2));

p3 = Paragraph(['Because I have not added another Heading1 object '...
    'since the last one, the heading from the previous page appears in the footer.']);
p3.Style = {PageBreakBefore(true)};
append(d,p3);

close(d);
rptview(d.OutputPath);

В этом примере показано, как задать имя стиля для содержимого ссылки. В этом примере создаются два StyleRef объекты: объект, использующий значение по умолчанию (Heading1 объекты) и тот, который использует содержимое абзаца, отформатированного с помощью Subtitle имя стиля. Вставка обоих объектов в нижний колонтитул так, чтобы нижний колонтитул содержал текст в форме [Most Recent Heading1 Name]: [Most Recent Subtitle Name].

import mlreportgen.dom.*;
d = Document('mydoc','docx');
open(d);

% Create page footer
footer = DOCXPageFooter('default');
d.CurrentPageLayout.PageFooters = footer;

% Create two StyleRef objects. ref uses content of Heading1 objects;
% ref2 uses content of paragraphs that use Subtitle style name.
ref = StyleRef();
ref2 = StyleRef('Subtitle');

% Assemble the footer text
footpara = Paragraph();
footpara.WhiteSpace = 'preserve';
append(footpara,ref);
append(footpara,': ');
append(footpara,ref2);
append(footer,footpara);

% Create Heading1 and Subtitle paragraphs
% Footers update based on most recent values
h = Heading1('My Document Title');
sub = Paragraph('Subtitle Text');
sub.StyleName = 'Subtitle';
p = Paragraph('Here''s some text.');
append(d,h);
append(d,sub);
append(d,p);

sub2 = Paragraph('Another Subtitle');
sub2.StyleName = 'Subtitle';
sub2.Style = {PageBreakBefore(true)};
append(d,sub2);
append(d,clone(p));

close(d);
rptview(d.OutputPath);
Представлен в R2016a