FGX.WebBrowser.TfgCustomWebBrowser: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показано 18 промежуточных версий этого же участника)
Строка 1: Строка 1:
* [[ FGX.WebBrowser | Вверх к родителю: FGX.WebBrowser ]]
+
* [[ FGX.Controls.TfgControl | Вверх к родителю: TfgControl ]]
 +
* [[ FGX.WebBrowser | К модулю: FGX.WebBrowser ]]
  
 
Delphi
 
Delphi
  
<code lang="Delphi">TfgCustomWebBrowser = class (TfgControl, IFGXTapSupported, IFGXNotificationObserver, IFGXNotificationObservable)</code>
+
<syntaxhighlight lang="Delphi">TfgCustomWebBrowser = class (TfgControl)</syntaxhighlight>
 +
 
 +
<p class="class-inheritance"><span class="type-border">[[System.Classes.TComponent|TComponent]]</span> -> <span class="type-border">[[FGX.Controls.TfgControl|TfgControl]]</span> -> <span class="type-border">[[FGX.WebBrowser.TfgCustomWebBrowser|TfgCustomWebBrowser]]</span></p>
 +
 
 +
Прямые наследники:
 +
[[FGX.WebBrowser.TfgWebBrowser|TfgWebBrowser]]
  
 
== Описание ==
 
== Описание ==
  
Описание отсутствует.
+
<span style="color:gray">Описание отсутствует.</span>
 
 
 
== Методы ==
 
== Методы ==
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">LoadHTML(const AHtml: [[string]]; const AUrl: [[string]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">LoadHTML(const AHtml: [[string]]; const AUrl: [[string]])</code>
Загрузить HTML страницу из буфера '' AHTML '' и сопоставить ей путь '' AUrl '' .
+
<p>Загрузить HTML страницу из буфера <i>AHTML</i> и сопоставить ей путь <i>AUrl</i> .</p>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">LoadRequest(const AUrl: [[string]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">LoadRequest(const AUrl: [[string]])</code>
Загрузить веб ресурс по URL.
+
<p>Загрузить веб ресурс по URL.</p>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">Reload()</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Reload()</code>
Перезагрузить текущий веб-ресурс.
+
<p>Перезагрузить текущий веб-ресурс.</p>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">StopLoading()</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">StopLoading()</code>
Остановить текущую загрузку веб-ресурса.
+
<p>Остановить текущую загрузку веб-ресурса.</p>
 
|-
 
|-
| <code lang="Delphi">function</code> || <code lang="Delphi">IsRequestLoading()</code>
+
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsRequestLoading(): [[Boolean]]</code>
Загружается ли сейчас веб-ресурс?
+
<p>Загружается ли сейчас веб-ресурс?</p>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">GoBack()</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">GoBack()</code>
Вернуться к предыдущему ресурсу по истории, если он был открыт до этого.
+
<p>Вернуться к предыдущему ресурсу по истории, если он был открыт до этого.</p>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">GoForward()</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">GoForward()</code>
Перейти к следующему ресурсу по истории.
+
<p>Перейти к следующему ресурсу по истории.</p>
 
|-
 
|-
| <code lang="Delphi">function</code> || <code lang="Delphi">CanGoBack()</code>
+
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">CanGoBack(): [[Boolean]]</code>
Можно ли перейти к предыдущему веб-ресурсу по истории?
+
<p>Можно ли перейти к предыдущему веб-ресурсу по истории?</p>
 
|-
 
|-
| <code lang="Delphi">function</code> || <code lang="Delphi">CanGoForward()</code>
+
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">CanGoForward(): [[Boolean]]</code>
Можно ли перейти к следующему веб-ресурсу по истории?
+
<p>Можно ли перейти к следующему веб-ресурсу по истории?</p>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">ScrollBy(const ADX: [[Single]]; const ADY: [[Single]]; const AAnimate: [[Boolean]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ScrollBy(const ADX: [[Single]]; const ADY: [[Single]]; const AAnimate: [[Boolean]])</code>
Выполняет прокручивание контента на вектор ( '' ADX '' , '' ADY '' ).
+
 
 +
<p>Выполняет прокручивание контента на вектор ( <i>ADX</i> , <i>ADY</i> ).</p><div class="info">Флаг <i>AAnimate</i> не поддерживается на Андроиде.</div>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">ScrollTo(const AX: [[Single]]; const AY: [[Single]]; const AAnimate: [[Boolean]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ScrollTo(const AX: [[Single]]; const AY: [[Single]]; const AAnimate: [[Boolean]])</code>
Выполняет смещение конента '' ContentOffset '' в указанную позицию ( '' AX '' , '' AX '' ).
+
 
 +
<p>Выполняет смещение конента <i>ContentOffset</i> в указанную позицию ( <i>AX</i> , <i>AX</i> ).</p><div class="info">Флаг <i>AAnimate</i> не поддерживается на Андроиде.</div>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">ScrollTop(const AAnimate: [[Boolean]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ScrollTop(const AAnimate: [[Boolean]])</code>
Выполняет прокручивание контента к началу страницы (верхняя позиция).
+
 
 +
<p>Выполняет прокручивание контента к началу страницы (верхняя позиция).</p><div class="info">Флаг <i>AAnimate</i> не поддерживается на Андроиде.</div>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">ScrollBottom(const AAnimate: [[Boolean]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ScrollBottom(const AAnimate: [[Boolean]])</code>
Выполняет прокручивание контента к концу страницы (нижняя позиция).
+
 
 +
<p>Выполняет прокручивание контента к концу страницы (нижняя позиция).</p><div class="info">Флаг <i>AAnimate</i> не поддерживается на Андроиде.</div>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">EvaluateJavascript(const AScript: [[string]]; const AValueCallback: [[.TfgJavascriptResultCallback|TfgJavascriptResultCallback]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">EvaluateJavascript(const AScript: [[string]]; const AValueCallback: [[TfgJavascriptResultCallback|TfgJavascriptResultCallback]])</code>
Асинхронно выполняет переданный Javascript код. Результат приходит в колбек '' AValueCallback '' .
+
 
 +
<p>Асинхронно выполняет переданный Javascript код. Результат приходит в колбек <i>AValueCallback</i> .</p><div class="info">Обработчик результата может быть nil.</div>
 
|-
 
|-
| <code lang="Delphi">procedure</code> || <code lang="Delphi">EvaluateJavascript(const AScript: [[string]]; const AValueEvent: [[TfgJavascriptResultEvent]])</code>
+
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">EvaluateJavascript(const AScript: [[string]]; const AValueEvent: [[TfgJavascriptResultEvent|TfgJavascriptResultEvent]])</code>
Асинхронно выполняет переданный Javascript код. Результат приходит в обработчик события '' AValueEvent '' .
+
 
 +
<p>Асинхронно выполняет переданный Javascript код. Результат приходит в обработчик события <i>AValueEvent</i> .</p><div class="info">Обработчик результата может быть nil.</div>
 
|}
 
|}
  
Строка 63: Строка 74:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
| <code>property</code> || <code>ContentSize: [[TSizeF]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ContentSize: [[TSizeF]]</code>
Размер страницы.
+
<p>Размер страницы.</p>
 
|-
 
|-
| <code>property</code> || <code>ContentOffset: [[TPointF]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ContentOffset: [[TPointF]]</code>
Текущее смещение страницы (позиция скроллинга).
+
<p>Текущее смещение страницы (позиция скроллинга).</p>
 
|-
 
|-
| <code>property</code> || <code>Url: [[string]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Url: [[string]]</code>
 
+
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
|}
  
Строка 77: Строка 88:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
| <code>event</code> || <code>OnDecideLoadUrl: [[TfgDecideLoadUrlEvent]]</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnDecideLoadUrl: [[TfgDecideLoadUrlEvent|TfgDecideLoadUrlEvent]]</code>
Вызывается в момент, когда пользователь инициирует переход по урлу. Позволяет запретить переход, чтобы перехватить переход по урлу.
+
<p>Вызывается в момент, когда пользователь инициирует переход по урлу. Позволяет запретить переход, чтобы перехватить переход по урлу.</p><p>Например, если загрузить в браузер свою HTML страницу с картинками и каждой странице присвоить ссылку для просмотра в полноэкранном режиме, то, используя это событие, можно поймать ссылку на оригинальную картинку и открывать ее не в браузере, а в отдельном окне.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnScroll: [[TfgScrollEvent|TfgScrollEvent]]</code>
 +
<p>Постоянно срабатывает при прокручивании страницы. В параметрах содержит предыдущее и новое значения смещения окна просмотра.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnStartLoading: [[TfgStartLoadingEvent|TfgStartLoadingEvent]]</code>
 +
<p>Загрузка контента по урлу начинается.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnFinishLoading: [[TfgFinishLoadingEvent|TfgFinishLoadingEvent]]</code>
  
Например, если загрузить в браузер свою HTML страницу с картинками и каждой странице присвоить ссылку для просмотра в полноэкранном режиме, то, используя это событие, можно поймать ссылку на оригинальную картинку и открывать ее не в браузере, а в отдельном окне.
+
<p>Загрузка контента по урлу закончена.</p><div class="info">Вызывается, даже если при загрузки контента произошла ошибка.</div>
|-
 
| <code>event</code> || <code>OnScroll: [[TfgScrollEvent]]</code>
 
Постоянно срабатывает при прокручивании страницы. В параметрах содержит предыдущее и новое значения смещения окна просмотра.
 
 
|-
 
|-
| <code>event</code> || <code>OnStartLoading: [[TfgStartLoadingEvent]]</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnErrorLoading: [[TfgErrorLoadingEvent|TfgErrorLoadingEvent]]</code>
Загрузка контента по урлу начинается.
+
<p>Загрузка контента закончилась с ошибкой.</p>
 
|-
 
|-
| <code>event</code> || <code>OnFinishLoading: [[TfgFinishLoadingEvent]]</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnBasicAuthentificationRequest: [[TfgBasicAuthentificationRequestEvent|TfgBasicAuthentificationRequestEvent]]</code>
Загрузка контента по урлу закончена.
+
<p>Вызывается, когда для загрузки страницы требуется Basic авторизация. Используйте параметр <i>AHandler</i> для отмены запроса или же для указание данных аутентификации.</p>
 
|-
 
|-
| <code>event</code> || <code>OnErrorLoading: [[TfgErrorLoadingEvent]]</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSSLError: [[TfgSSLErrorEvent|TfgSSLErrorEvent]]</code>
Загрузка контента закончилась с ошибкой.
+
<p>Вызывается, когда при загрузке страницы наблюдается проблема с SSL сертификатом. Используйте параметр <i>AHandler</i> для отмены загрузки страницы или для игнорирования ошибки и продолжения загрузки.</p>
 
|}
 
|}

Текущая версия на 17:29, 23 декабря 2022

Delphi

TfgCustomWebBrowser = class (TfgControl)

TComponent -> TfgControl -> TfgCustomWebBrowser

Прямые наследники: TfgWebBrowser

Описание

Описание отсутствует.

Методы

procedure
LoadHTML(const AHtml: string; const AUrl: string)

Загрузить HTML страницу из буфера AHTML и сопоставить ей путь AUrl .

procedure
LoadRequest(const AUrl: string)

Загрузить веб ресурс по URL.

procedure
Reload()

Перезагрузить текущий веб-ресурс.

procedure
StopLoading()

Остановить текущую загрузку веб-ресурса.

function
IsRequestLoading(): Boolean

Загружается ли сейчас веб-ресурс?

procedure
GoBack()

Вернуться к предыдущему ресурсу по истории, если он был открыт до этого.

procedure
GoForward()

Перейти к следующему ресурсу по истории.

function
CanGoBack(): Boolean

Можно ли перейти к предыдущему веб-ресурсу по истории?

function
CanGoForward(): Boolean

Можно ли перейти к следующему веб-ресурсу по истории?

procedure
ScrollBy(const ADX: Single; const ADY: Single; const AAnimate: Boolean)

Выполняет прокручивание контента на вектор ( ADX , ADY ).

Флаг AAnimate не поддерживается на Андроиде.
procedure
ScrollTo(const AX: Single; const AY: Single; const AAnimate: Boolean)

Выполняет смещение конента ContentOffset в указанную позицию ( AX , AX ).

Флаг AAnimate не поддерживается на Андроиде.
procedure
ScrollTop(const AAnimate: Boolean)

Выполняет прокручивание контента к началу страницы (верхняя позиция).

Флаг AAnimate не поддерживается на Андроиде.
procedure
ScrollBottom(const AAnimate: Boolean)

Выполняет прокручивание контента к концу страницы (нижняя позиция).

Флаг AAnimate не поддерживается на Андроиде.
procedure
EvaluateJavascript(const AScript: string; const AValueCallback: TfgJavascriptResultCallback)

Асинхронно выполняет переданный Javascript код. Результат приходит в колбек AValueCallback .

Обработчик результата может быть nil.
procedure
EvaluateJavascript(const AScript: string; const AValueEvent: TfgJavascriptResultEvent)

Асинхронно выполняет переданный Javascript код. Результат приходит в обработчик события AValueEvent .

Обработчик результата может быть nil.

Свойства

property
ContentSize: TSizeF

Размер страницы.

property
ContentOffset: TPointF

Текущее смещение страницы (позиция скроллинга).

property
Url: string

Описание отсутствует.

События

event
OnDecideLoadUrl: TfgDecideLoadUrlEvent

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

Например, если загрузить в браузер свою HTML страницу с картинками и каждой странице присвоить ссылку для просмотра в полноэкранном режиме, то, используя это событие, можно поймать ссылку на оригинальную картинку и открывать ее не в браузере, а в отдельном окне.

event
OnScroll: TfgScrollEvent

Постоянно срабатывает при прокручивании страницы. В параметрах содержит предыдущее и новое значения смещения окна просмотра.

event
OnStartLoading: TfgStartLoadingEvent

Загрузка контента по урлу начинается.

event
OnFinishLoading: TfgFinishLoadingEvent

Загрузка контента по урлу закончена.

Вызывается, даже если при загрузки контента произошла ошибка.
event
OnErrorLoading: TfgErrorLoadingEvent

Загрузка контента закончилась с ошибкой.

event
OnBasicAuthentificationRequest: TfgBasicAuthentificationRequestEvent

Вызывается, когда для загрузки страницы требуется Basic авторизация. Используйте параметр AHandler для отмены запроса или же для указание данных аутентификации.

event
OnSSLError: TfgSSLErrorEvent

Вызывается, когда при загрузке страницы наблюдается проблема с SSL сертификатом. Используйте параметр AHandler для отмены загрузки страницы или для игнорирования ошибки и продолжения загрузки.