helpcenter/helpcenter.r7-office.ru/Web/Controls/Help/APIEditors/Advanced.ascx
2019-02-25 13:59:30 +03:00

157 lines
9.4 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<%@ Control Language="C#" Inherits="BaseContentUserControls" %> <%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %><script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Advanced parameters";
MetaDescription = "Статьи документации по API сервера документов.";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Расширенные параметры</h1>
<p class="dscr">Параметры, которые могут быть изменены для Сервера документов, можно подразделить на следующие основные разделы:</p><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/.aspx")%>"><b>config</b></a> - позволяет изменить тип используемой платформы, размер отображения документа (ширину и высоту), а также тип открытого документа;<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document.aspx")%>"><b>document</b></a> - содержит все параметры, относящиеся к документу (название, ссылку, тип файла, и т.д.);<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document/info.aspx")%>"><b>info</b></a> - содержит дополнительные параметры документа (автора документа, название папки, в которой хранится документ, дату создания, параметры обмена);</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/document/permissions.aspx")%>"><b>permissions</b></a> - определяет, может ли документ быть отредактирован и скачан;</li>
</ul>
</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor.aspx")%>"><b>editorConfig</b></a> - определяет параметры, относящиеся к интерфейсу редактора (режим открытия (просмотр или редактирование), язык интерфейса, дополнительные кнопки, и т.д.);<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor/customization.aspx")%>"><b>customization</b></a> - позволяет настраивать интерфейс редактора, чтобы он выглядел как остальные ваши продукты (если они есть) и показывать или скрывать дополнительные кнопки, ссылки, изменять логотипы и информацию о владельце редактора;</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor/embedded.aspx")%>"><b>embedded</b></a> - используется только для встроенных типов документов и позволяет изменять поведение кнопок, используемых для управления встроенным режимом;</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor/plugins.aspx")%>"><b>plugins</b></a> - используется для подключения необходимых <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/editor/plugins.aspx")%>">плагинов</a> к вашему Серверу Документов, что позволит сделать их видимыми для всех пользователей, редактирующих документ;</li>
</ul>
</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/config/events.aspx")%>"><b>events</b></a> - список специальных событий, вызываемых, когда какое-либо действие применяется к документу (загрузка документа, изменение, и т.д.);</li>
</ul>
<p>Полный <em>config</em>, со всеми дополнительными параметрами выглядит следующим образом:</p>
<pre>
config = {
"document": {
"fileType": "docx",
"info": {
"author": "Иван Петров",
"created": "2010-07-07 3:46 PM",
"folder": "Примеры файлов",
"sharingSettings": [
{
"permissions": "Полный доступ",
"user": "Иван Петров"
},
{
"permissions": "Только для чтения",
"user": "Елена Иванова"
},
...
]
},
"key": "Khirz6zTPdfd7",
"permissions": {
"comment": true,
"download": true,
"edit": true,
"fillForms": true,
"print": true,
"review": true
},
"title": "Пример названия документа.docx",
"url": "https://example.com/url-to-example-document.docx"
},
"documentType": "text",
"editorConfig": {
"callbackUrl": "https://example.com/url-to-callback.ashx",
"createUrl": "https://example.com/url-to-create-document/",
"customization": {
"autosave": true,
"chat": true,
"commentAuthorOnly": false,
"compactToolbar": false,
"customer": {
"address": "Мой город, 123-45",
"info": "Дополнительная информация",
"logo": "https://example.com/logo-big.png",
"mail": "john@example.com",
"name": "Иван Петров и сыновья.",
"www": "example.com"
},
"feedback": {
"url": "https://example.com",
"visible": true
},
"forcesave": false,
"goback": {
"blank": true,
"text": "Вернуться к документам",
"url": "https://example.com"
},
"help": true,
"logo": {
"image": "https://example.com/logo.png",
"imageEmbedded": "https://example.com/logo_em.png",
"url": "https://example.com"
},
"showReviewChanges": false,
"zoom": 100
},
"embedded": {
"embedUrl": "https://example.com/embedded?doc=exampledocument1.docx",
"fullscreenUrl": "https://example.com/embedded?doc=exampledocument1.docx#fullscreen",
"saveUrl": "https://example.com/download?doc=exampledocument1.docx",
"shareUrl": "https://example.com/view?doc=exampledocument1.docx",
"toolbarDocked": "top"
},
"lang": "ru-RU",
"mode": "edit",
"plugins": {
"autostart": [
"asc.{0616AE85-5DBE-4B6B-A0A9-455C4F1503AD}",
"asc.{FFE1F462-1EA2-4391-990D-4CC84940B754}",
...
],
"pluginsData": [
"https://example.com/plugin1/config.json",
"https://example.com/plugin2/config.json",
...
]
},
"recent": [
{
"folder": "Примеры файлов",
"title": "exampledocument1.docx",
"url": "https://example.com/exampledocument1.docx"
},
{
"folder": "Примеры файлов",
"title": "exampledocument2.docx",
"url": "https://example.com/exampledocument2.docx"
},
...
],
"user": {
"id": "78e1e841",
"name": "Иван Петров"
}
},
"events": {
"onAppReady": onAppReady,
"onCollaborativeChanges": onCollaborativeChanges,
"onDocumentReady": onDocumentReady,
"onDocumentStateChange": onDocumentStateChange,
"onDownloadAs": onDownloadAs,
"onError": onError,
"onInfo": onInfo,
"onOutdatedVersion": onOutdatedVersion,
"onRequestClose": onRequestClose,
"onRequestEditRights": onRequestEditRights,
"onRequestHistory": onRequestHistory,
"onRequestHistoryClose": onRequestHistoryClose,
"onRequestHistoryData": onRequestHistoryData,
"onWarning": onWarning
},
"height": "100%",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.t-IDcSemACt8x4iTMCda8Yhe3iZaWbvV5XKSTbuAn0M",
"type": "desktop",
"width": "100%"
};
</pre>
<p>Где <b>example.com</b> - имя сервера, на котором установлены <b>менеджер документов</b> и <b>сервис хранения документов</b>. Смотрите раздел <a href="<%=VirtualPathUtility.ToAbsolute("~/api/editors/howitworks.aspx")%>">Как это работает</a>, чтобы узнать больше о клиент-серверных взаимодействиях Сервера документов.</p>
</div>