Наименование

Описание

ID

Строковый уникальный идентификатор компонента, по умолчанию StiBlazorViewer.

Report

Объект отчёта, который будет отображён во вьювере.

Localization

Задает путь к XML файлу локализации. Путь может быть абсолютным либо относительным. По умолчанию используется английская локализация, которая встроена во вьювер и не требует дополнительных XML файлов.

Width

Задает ширину компонента в необходимых единицах измерения – пикселях (по умолчанию), процентах, поинтах. Например, “500”, “500px”, “100%”, “300pt”. По умолчанию установлена ширина 100%.

Height

Задает высоту компонента в необходимых единицах измерения – пикселях (по умолчанию), процентах, поинтах. Например, “500”, “500px”, “100%”, “300pt”. По умолчанию установлена автоматическая высота в зависимости от размера страницы отчета, либо 650 пикселей в режиме отображения вьювера с полосами прокрутки.

Options

Представляет возможность задать объект класса StiBlazorViewerOptions, который содержит набор опций (настроек) компонента.

Theme

Задает тему оформления вьювера. Список доступных тем оформления находится в перечислении StiViewerTheme. По умолчанию установлено значение Office2022WhiteBlue.

Наименование

Описание

UseRelativeUrls

Устанавливает режим дизайнера, в котором для запросов на сервер используются относительные ссылки. По умолчанию свойство имеет значение true.

PortNumber

Получает или задает значение, которое указывает номер порта для использования в URL. Значение 0 определяет автоматическое обнаружение (установлено по умолчанию). Значение -1 удаляет номер порта.

PassQueryParametersToReport

Включает использование всех параметров URL запроса в качестве значений одноименных переменных в отчете. По умолчанию свойство имеет значение false.

PassQueryParametersForResources

Включает передачу всех параметров URL запроса при формировании ссылок на ресурсы дизайнера. При значении false для запроса ресурсов дизайнера используются только необходимые параметры, что способствует более корректной работе кэша браузера. По умолчанию свойство имеет значение true.

PassFormValues

Включает передачу значений POST-формы на сторону клиента, если эти значения требуется использовать в действиях дизайнера. При включении данной возможности, вспомогательный метод GetFormValues() будет возвращать коллекцию параметров формы. По умолчанию свойство имеет значение false.

AllowLoadingCustomFontsToClientSide

Позволяет передавать пользовательские шрифты на клиентскую сторону и преобразовывать их в CSS стиль для корректного отображения текста на стороне HTML с заданным шрифтом. По умолчанию свойство имеет значение false.

Наименование

Описание

IconSet

Предоставляет возможность установить набор иконок:
 
StiWebUIIconSet.Auto (значение по умолчанию) -  устанавливает набор иконок автоматически. Для тем Office2022 - используется набор иконок в стиле Monoline, для тем Office2013 - используется набор иконок в стиле Regular.

StiWebUIIconSet.Monoline - устанавливает набор иконок в стиле Monoline;

StiWebUIIconSet.Regular - устанавливает набор иконок в стиле Regular.

CustomCss

Задает путь к CSS файлу стилей вьювера. Если данное свойство установлено, то стандартные стили выбранной темы загружены не будут. По умолчанию установлено пустое значение.

BackgroundColor

Задает цвет подложки вьювера. По умолчанию свойство имеет значение White.

PageBorderColor

Задает цвет границ страницы отчета. По умолчанию свойство имеет значение Gray.

RightToLeft

Устанавливает режим отображения Right to Left для элементов управления вьювера. По умолчанию свойство имеет значение false.

FullScreenMode

Устанавливает полноэкранный режим отображения вьювера. По умолчанию свойство имеет значение false.

ScrollbarsMode

Устанавливает режим отображения отчета с полосами прокрутки. По умолчанию свойство имеет значение false.

OpenLinksWindow

Задает целевое окно для открытия ссылок, содержащихся в отчете. По умолчанию свойство имеет значение Blank (новое окно).

OpenExportedReportWindow

Задает целевое окно для открытия файла экспорта из вьювера. По умолчанию свойство имеет значение Blank (новое окно).

DesignWindow

Задает целевое окно для открытия дизайнера отчетов. По умолчанию свойство имеет значение Self (текущее окно).

ShowTooltips

Включает отображение подсказок для элементов управления вьювера при наведении мыши. По умолчанию свойство имеет значение true.

ShowTooltipsHelp

Включает отображение ссылки на онлайн документацию в подсказках для элементов управления вьювера. По умолчанию свойство имеет значение true.

ShowDialogsHelp

Предоставляет возможность отображать или не отображать кнопку вызова справки в различных меню. По умолчанию, установлено значение true.

PageAlignment

Задает позицию страницы отчета в окне вьювера. Может принимать одно из указанных ниже значений перечисления StiContentAlignment:

Left – страница будет пристыкована к левому краю;

Center – страница будет центрирована (значение по умолчанию);

Right – страница будет пристыкована к правому краю.

ShowPageShadow

Включает отображение тени для страниц отчета. По умолчанию свойство имеет значение true.

BookmarksPrint

Включает печать закладок отчета на принтере (помимо самого отчета). По умолчанию свойство имеет значение false.

BookmarksTreeWidth

Устанавливает ширину панели закладок в пикселях. По умолчанию ширина имеет значение 180 пикселей.

ParametersPanelPosition

Задает позицию панели параметров отчета. Может принимать одно из указанных ниже значений перечисления StiParametersPanelPosition:

Top – панель будет пристыкована к верхнему краю (значение по умолчанию);

Left – панель будет пристыкована к левому краю.

ParametersPanelMaxHeight

Устанавливает максимальную высоту панели параметров в пикселях. По умолчанию максимальная высота имеет значение 300 пикселей.

ParametersPanelColumnsCount

Устанавливает количество колонок для отображения параметров отчета. По умолчанию разбиение производится на 2 колонки.

ParametersPanelSortDataItems

Устанавливает или выключает режим сортировки значений переменной. По умолчанию, опция установлена в значение true, т.е. значения переменной сортируются.

ParametersPanelDateFormat

Устанавливает формат даты и времени для переменных соответствующего типа на панели параметров. По умолчанию используется формат даты и времени, установленный браузером.

InterfaceType

Устанавливает тип используемого интерфейса вьювера. Может принимать одно из указанных ниже значений перечисления StiInterfaceType:

Auto – тип интерфейса вьювера будет выбран автоматически в зависимости от используемого устройства (значение по умолчанию);

Mouse – принудительное использование стандартного интерфейса для управления вьювером при помощи мыши;

Touch – принудительное использование Touch интерфейса для управления вьювером при помощи сенсорного экрана монитора, в этом режиме элементы интерфейса вьювера имеют увеличенные размеры для удобства управления;

Mobile – принудительное использование Mobile интерфейса для управления вьювером при помощи экрана смартфона, в этом режиме интерфейс вьювера имеет упрощенный вид и адаптирован для управления при помощи мобильного устройства.

AllowMobileMode

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

ChartRenderType

Устанавливает режим отображения диаграмм на странице отчета. Может принимать одно из указанных ниже значений перечисления StiChartRenderType:

Image – диаграммы отображаются в виде статичных изображений;

Vector – диаграммы отображаются в векторном режиме в виде SVG объекта;

AnimatedVector - диаграммы отображаются в векторном режиме в виде SVG объекта, элементы диаграммы появляются с анимацией (значение по умолчанию).

ReportDisplayMode

Устанавливает режим экспорта для отображения страниц отчета. Может принимать одно из указанных ниже значений перечисления StiReportDisplayMode:

FromReport - режим экспорта элементов отчета определяется из настроек шаблона - Div или Table;

Table – элементы отчета экспортируются с использованием HTML таблиц (значение по умолчанию);

Div – элементы отчета экспортируются с использованием DIV разметки;

Span - элементы отчета экспортируются с использованием SPAN разметки.

DatePickerFirstDayOfWeek

Устанавливает первый день недели для элемента выбора даты. Может принимать одно из указанных ниже значений перечисления StiFirstDayOfWeek:

Auto – автоматическое определение первого дня недели из настроек браузера (значение по умолчанию);

Monday – первым днем недели является понедельник;

Sunday – первым днем недели является воскресенье.

DatePickerIncludeCurrentDayForRanges

Предоставляет возможность включать или не включать текущий день в диапазон значений элемента Выбор даты (Date Picker). По умолчанию, опция установлена в значение false, т.е. текущий день не включается в диапазон значений элемента.

AllowTouchZoom

Включает возможность изменения масштаба страницы отчета специальным двух пальцевым жестом (Pinch to Zoom) на сенсорном экране устройства. По умолчанию свойство имеет значение true.

ShowReportIsNotSpecifiedMessage

Предоставляет возможность отображать или не отображать уведомление, если отчет не задан. По умолчанию свойство имеет значение true.

PrintToPdfMode

Устанавливает режим печати в PDF документ. Может принимать значения:

StiPrintToPdfMode.Hidden - скрытый режим печати (по умолчанию);
StiPrintToPdfMode.Popup - документ PDF будет отображет перед печатью во всплывающем окне.

ImagesQuality

Получает или задает качество изображения, которое будет использоваться на странице вьювера. Может принимать значения:

StiImagesQuality.Low  -  низкое качество, используется для ускорения загрузки отчета и экономии памяти

StiImagesQuality.Normal  -  обычное качество, подходит для большинства ситуаций, установлено по умолчанию

StiImagesQuality.High  -  высокое качество, используется для мониторов высокой четкости, но может замедлять загрузку страниц

CombineReportPages

Предоставляет возможность объединить обработанные страницы шаблона отчета в один шаблон или представить каждую страницу шаблона отдельной вкладкой во вьювере.  По умолчанию, опция установлена в значение false, т.е. каждая страница шаблона отчета будет представлена отдельной вкладкой во вьювере.

Наименование

Описание

Visible

Включает отображение панели инструментов вьювера. По умолчанию свойство имеет значение true.

DisplayMode

Задает режим отображения панели инструментов вьювера. Может принимать одно из указанных ниже значений перечисления StiToolbarDisplayMode:

Simple – простой режим отображения, все элементы управления расположены на одной панели управления (значение по умолчанию);

Separated – раздельный режим отображения, панель управления разделена на верхнюю и нижнюю.

BackgroundColor

Задает цвет панели инструментов вьювера. По умолчанию используется цветовое оформление выбранной темы.

BorderColor

Задает цвет границ панели инструментов вьювера. По умолчанию используется цветовое оформление выбранной темы.

FontColor

Задает цвет текста для панели инструментов и меню вьювера. По умолчанию используется цветовое оформление выбранной темы.

FontFamily

Задает шрифт для панели инструментов и меню вьювера. По умолчанию используется шрифт выбранной темы.

Alignment

Устанавливает режим выравнивания элементов управления на панели инструментов вьювера. Может принимать одно из указанных ниже значений перечисления StiContentAlignment:

Left – элементы будут пристыкованы к левому краю;

Center – элементы будут располагаться по центру панели;

Right – элементы будут пристыкованы к правому краю;

Default – выравнивание зависит от свойства RightToLeft (значение по умолчанию)

ShowButtonCaptions

Включает отображение текста кнопок панели инструментов вьювера. По умолчанию свойство имеет значение true.

ShowPrintButton

Включает отображение кнопки Печать (Print) на панели инструментов вьювера. По умолчанию свойство имеет значение true.

ShowOpenButton

Включает отображение кнопки Открыть (Open) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение true.

ShowSaveButton

Включает отображение кнопки Сохранить (Save) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение true.

ShowSendEmailButton

Включает отображение кнопки Отправиль Email (Send Email) на панели инструментов вьювера. По умолчанию свойство имеет значение false. Также, необходимо подписаться на событие OnEmailReport.

ShowFindButton

Включает отображение кнопки Поиск (Find) на панели инструментов вьювера. По умолчанию свойство имеет значение true.

ShowBookmarksButton

Включает отображение кнопки Закладки (Bookmarks) на панели инструментов вьювера. По умолчанию свойство имеет значение true. Если указанная кнопка скрыта, то панель закладок не будет отображена даже при наличии закладок в отчете.

ShowParametersButton

Включает отображение кнопки Параметры (Parameters) на панели инструментов вьювера. По умолчанию свойство имеет значение true. Если указанная кнопка скрыта, то панель параметров не будет отображена даже при наличии параметров в отчете.

ShowResourcesButton

Включает отображение кнопки Ресурсы (Resources) на панели инструментов вьювера. По умолчанию свойство имеет значение true. Если указанная кнопка скрыта, то панель ресурсов не будет отображена.

ShowEditorButton

Включает отображение кнопки Редактор (Editor) на панели инструментов вьювера при просмотре отчетов. По умолчанию свойство имеет значение true.

ShowFullScreenButton

Включает отображение кнопки Полноэкранный просмотр (Full Screen) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение true.

ShowFirstPageButton

Включает отображение кнопки Первая страница (First Page) на панели инструментов вьювера. По умолчанию свойство имеет значение true.

ShowPreviousPageButton

Включает отображение кнопки Предыдущая страница (Previous Page) на панели инструментов вьювера. По умолчанию свойство имеет значение true.

ShowCurrentPageControl

Включает отображение индикатора текущей страницы отчета. По умолчанию свойство имеет значение true.

ShowNextPageButton

Включает отображение кнопки Следующая страница (Next Page) на панели инструментов вьювера. По умолчанию свойство имеет значение true.

ShowLastPageButton

Включает отображение кнопки Последняя страница (Last Page) на панели инструментов вьювер. По умолчанию свойство имеет значение true.

ShowZoomButton

Включает отображение кнопки выбора масштаба отчета. По умолчанию свойство имеет значение true.

ShowViewModeButton

Включает отображение кнопки выбора режима отображения страниц отчета. По умолчанию свойство имеет значение true.

ShowDesignButton

Включает отображение кнопки Дизайн (Design) на панели инструментов вьювера при просмотре отчетов или панели индикаторов (дашбордов). По умолчанию свойство имеет значение false.

ShowAboutButton

Включает отображение кнопки О программе (About) на панели инструментов вьювера. По умолчанию свойство имеет значение true.

ShowRefreshButton

Включает или выключает отображение кнопки Обновить (Refresh) на панели инструментов вьювера при просмотре панелей индикаторов (дашбордов). По умолчанию свойство имеет значение true.

ShowPinToolbarButton

Включает отображение кнопки Прикрепить панель (Pin Toolbar) на панели инструментов вьювера. Кнопка доступна только в мобильном режиме вьювера. По умолчанию свойство имеет значение true.

PrintDestination

Устанавливает режим печати отчета. Может принимать одно из указанных ниже значений перечисления StiPrintDestination:

Default – будет отображено меню с предоставлением выбора режима печати (значение по умолчанию);

Pdf – печать будет осуществлена в формате PDF;

Direct – печать будет осуществлена в формате HTML непосредственно на принтер, будет отображен системный диалог печати;

PopupWindow – печать будет осуществлена в формате HTML через всплывающее окно предварительного просмотра отчета.

ViewMode

Устанавливает режим отображения страниц отчета. Может принимать одно из указанных ниже значений перечисления StiWebViewMode:

SinglePage – отображается одна страница отчета, выбранная на панели инструментов вьювера (значение по умолчанию);

Continuous – отображаются все страницы отчета в виде ленты;

MultiplePages – отображаются все страницы отчета в виде таблицы.

Zoom

Задает масштаб отображения страниц отчета. По умолчанию установлен масштаб 100 процентов. Допускаются значения от 10 до 500 процентов. Также допускается устанавливать одно из следующих значений:

StiZoomMode.PageWidth – при запуске вьювера будет установлен масштаб, необходимый для отображения отчета по ширине страницы;

StiZoomMode.PageHeight – при запуске вьювера будет установлен масштаб, необходимый для отображения отчета по высоте страницы.

MenuAnimation

Включает анимацию при появлении/скрытии меню вьювера. По умолчанию свойство имеет значение true.

ShowMenuMode

Устанавливает режим отображения меню вьювера. Может принимать одно из указанных ниже значений перечисления StiShowMenuMode:

Click – отображение по клику мыши (значение по умолчанию);

Hover – отображение по наведении курсора мыши.

AutoHide

Включает автоматическое сворачивание панели инструментов вьювера. Свойство работает только в мобильном режиме вьювера. По умолчанию свойство имеет значение false.

Наименование

Описание

DefaultSettings

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

StoreExportSettings

Включает режим сохранения выбранных настроек в диалоговых окнах экспорта. Настройки будут храниться в cookies браузера. По умолчанию свойство имеет значение true.

ShowExportDialog

Включает отображение диалогового окна параметров экспорта. Если свойство имеет значение false, то экспортирование будет производиться с заданными по умолчанию настройками. По умолчанию свойство имеет значение true.

ShowExportToDocument

Включает отображение пункта меню экспорта Файл документа (Document File). По умолчанию свойство имеет значение true.

ShowExportToPdf

Включает отображение пункта меню экспорта Adobe PDF файл (Adobe PDF File) при просмотре отчетов, и пункт Adobe PDF при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToXps

Включает отображение пункта меню экспорта Microsoft XPS файл (Microsoft XPS File). По умолчанию свойство имеет значение false.

ShowExportToPowerPoint

Включает отображение пункта меню экспорта Microsoft PowerPoint 2007/2010 файл (Microsoft PowerPoint 2007/2010 File). По умолчанию свойство имеет значение true.

ShowExportToHtml

Включает отображение пункта меню экспорта HTML файл (HTML File). По умолчанию свойство имеет значение true.

ShowExportToHtml5

Включает отображение пункта меню экспорта HTML5 файл (HTML5 File). По умолчанию свойство имеет значение true.

ShowExportToMht

Включает отображение пункта меню экспорта MHT Web архив (MHT Web Archive). По умолчанию свойство имеет значение true.

ShowExportToText

Включает отображение пункта меню экспорта Text файл (Text File). По умолчанию свойство имеет значение true.

ShowExportToRtf

Включает отображение пункта меню экспорта Rich Text файл (Rich Text File). По умолчанию свойство имеет значение true.

ShowExportToWord

Включает отображение пункта меню экспорта Microsoft Word 2007/2010 файл (Microsoft Word 2007/2010 File). По умолчанию свойство имеет значение true.

ShowExportToOpenDocumentWriter

Включает отображение пункта меню экспорта OpenDocument Writer файл (OpenDocument Writer File). По умолчанию свойство имеет значение true.

ShowExportToExcelBiff

Включает отображение пункта меню экспорта Microsoft Excel файл (Microsoft Excel File). По умолчанию свойство имеет значение true.

ShowExportToExcelXml

Включает отображение пункта меню экспорта Microsoft Excel Xml файл (Microsoft Excel Xml File). По умолчанию свойство имеет значение true.

ShowExportToExcel

Включает отображение пункта меню экспорта Microsoft Excel 2007/2010 файл (Microsoft Excel 2007/2010 File) при просмотре отчетов, и пункт Microsoft Excel при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToOpenDocumentCalc

Включает отображение пункта меню экспорта OpenDocument Calc файл (OpenDocument Calc File). По умолчанию свойство имеет значение true.

ShowExportToCsv

Включает отображение пункта меню экспорта CSV файл (CSV File). По умолчанию свойство имеет значение true.

ShowExportToDbf

Включает отображение пункта меню экспорта DBF файл (DBF File). По умолчанию свойство имеет значение true.

ShowExportToXml

Включает отображение пункта меню экспорта XML файл (XML File). По умолчанию свойство имеет значение true.

ShowExportToDif

Включает отображение пункта меню экспорта Data Interchange формат (DIF) файл (Data Interchange Format (DIF) File). По умолчанию свойство имеет значение true.

ShowExportToSylk

Включает отображение пункта меню экспорта Symbolic Link (SYLK) файл (Symbolic Link (SYLK) File). По умолчанию свойство имеет значение true.

ShowExportToJson

Включает отображение пункта меню экспорта JSON файл (JSON File). По умолчанию свойство имеет значение true.

ShowExportToImageBmp

Включает отображение пункта меню экспорта BMP рисунок (BMP Image) при просмотре отчетов, и пункт BMP при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToImageGif

Включает отображение пункта меню экспорта GIF рисунок (GIF Image) при просмотре отчетов, и пункт GIF при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToImageJpeg

Включает отображение пункта меню экспорта JPEG рисунок (JPEG Image) при просмотре отчетов, и пункт JPEG при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToImagePcx

Включает отображение пункта меню экспорта PCX рисунок (PCX Image) при просмотре отчетов, и пункт PCX при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToImagePng

Включает отображение пункта меню экспорта PNG рисунок (PNG Image) при просмотре отчетов, и пункт PNG при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToImageTiff

Включает отображение пункта меню экспорта TIFF рисунок (TIFF Image) при просмотре отчетов, и пункт TIFF при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToImageSvg

Включает отображение пункта меню экспорта Scalable Vector Graphics (SVG) файл (Scalable Vector Graphics (SVG) File) при просмотре отчетов, и пункт SVG при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowExportToImageSvgz

Включает отображение пункта меню экспорта Compressed SVG (SVGZ) файл (Compressed SVG (SVGZ) File) при просмотре отчетов, и пункт SVGZ при просмотре панелей индикаторов. По умолчанию свойство имеет значение true.

ShowOpenAfterExport

Предоставляет возможность отображать или не отображать параметр Открыть после экспорта (Open After Export) в меню настроек экспорта. По умолчанию свойство имеет значение true.

Наименование

Описание

ShowEmailDialog

Включает отображение диалогового окна параметров отправки отчета по Email. Если диалоговое окно отключено, то отправка по Email будет производиться с настройками, заданными на стороне сервера при использовании события OnEmailReport. По умолчанию свойство имеет значение true.

ShowExportDialog

Включает отображение диалогового окна параметров экспорта при отправке Email. Если свойство имеет значение false, то экспортирование будет производиться с заданными по умолчанию настройками. По умолчанию свойство имеет значение true.

DefaultEmailAddress

Устанавливает Email получателя по умолчанию, т.е. адрес на который будет отправлено письмо с вложенным отчетом.

DefaultEmailSubject

Устанавливает тему (заголовок) электронного письма по умолчанию.

DefaultEmailMessage

Устанавливает сообщение (текст) электронного письма по умолчанию.

DefaultEmailReplyTo

Устанавливает сообщение (текст) по умолчанию для ответа на сообщение, созданное во вьювере.