mlreportgen.dom.StyleRef class

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

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

Описание

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

Для документа Word Microsoft® можно добавить 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 объекты. Используйте пользовательские атрибуты, поддержанные выходным форматом.

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

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

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

Объекты формата, которые задают формат элемента документа.

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

Пометьте для этого элемента документа в виде вектора символов или строкового скаляра.

DOM генерирует уникальный для сеанса тег как часть создания этого объекта. Сгенерированный тег имеет форму CLASS:ID, где КЛАСС является классом объекта, и 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
Для просмотра документации необходимо авторизоваться на сайте