TCustomRichView.OnSaveImage2

<< Нажмите, чтобы показать Содержание >>

TCustomRichView.OnSaveImage2

Событие происходит, когда TRichView сохраняет изображение в файл или поток формата HTML, Markdown или XML (с помощью компонента TRichViewXML).

type

  TRVSaveImageEvent2 = procedure (Sender: TCustomRichView;

    Graphic: TRVGraphic; SaveFormat: TRVSaveFormat;

    const Path, ImagePrefix: TRVUnicodeString;

    var ImageSaveNo: Integer; var Location: TRVUnicodeString;

    var DoDefault: Boolean) of object;

 

property OnSaveImage2: TRVSaveImageEvent2;

Для HTML это событие является альтернативой событию OnHTMLSaveImage. Оно проще в использовании, поскольку изображение доступно в параметре GraphicOnHTMLSaveImage вам нужно самостоятельно извлечь изображение из элемента или RVData). Кроме того, это событие имеет параметры ImagePrefix и ImageSaveNo, поэтому вам не нужно хранить их в глобальных переменных.

Для HTML, OnSaveImage2 не вызывается если:

опция rvhtmlsioUseItemImageFileNames включена в HTMLSaveProperties.ImageOptions и значение свойства элемента rvespImageFileName  не пустое;

параметр DoDefault события OnHTMLSaveImage был установлен в False для этого изображения.

Для Markdown, OnSaveImage2 не вызывается если:

опция rvmdsoUseItemImageFileNames включена в MarkdownProperties.SaveOptions и значение свойства элемента rvespImageFileName  не пустое.

 

Входные параметры:

Graphic изображение, которое нужно сохранить.

SaveFormat равен rvsfHTML, rvsfMarkdown или rvsfXML.

Path путь к сохраняемому файлу HTML или Markdown (или параметр Path методов SaveHTMLToStream/SaveMarkdownToStream)

ImagePrefix рекомендуемое начало имени файла (HTMLSaveProperties.ImagesPrefix или MarkdownProperties.ImagesPrefix)

ImageSaveNo значение, с помощью которого можно получить уникальное имя файла (см. метод GetNextFileName в описании OnHTMLSaveImage).

Дополнительные входные параметры:

Sender.Style.RVData (следует привести к типу TCustomRVData)  документ, содержащий сохраняемое изображение (RVData основного TRichView, ячейка, или RVData редактора ячейки).

Sender.Style.ItemNo номер элемента в Sender.Style.RVData. Если событие вызывается для фонового изображения (документа или ячейки таблицы), ItemNo=-1.

Выходные параметры:

Location имя файла сохранённого изображения. Эта строка будет записана в HTML/Markdown.

DoDefault установите в False если вы сохранили изображение. В противном случае будет вызвана стандартная процедура сохранения изображения.

 

Примечание: при сохранение изображений из TImageList (значков, интерактивных значков, маркеров списка с изображениями), TRichView создаёт временный объект TBitmap и передаёт его в это событие.

 

См. также события:

OnHTMLSaveImage;

OnSaveItemToFile;

OnImportPicture.

См. также:

Экспорт в HTML.