Exponenta Banner

mlreportgen.dom.StyleRef class

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

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

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

Описание

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

Для Майкрософт® 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

MATLAB Report Generator

Поддержка