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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показаны 33 промежуточные версии этого же участника)
Строка 1: Строка 1:
−
* [[ FGX.Edit | Вверх к родителю: FGX.Edit ]]
+
* [[ FGX.Controls.TfgControl | Вверх к родителю: TfgControl ]]
 +
* [[ FGX.Edit | К модулю: FGX.Edit ]]
  
 
Delphi
 
Delphi
  
−
<code lang="Delphi">TfgCustomEdit = class (TfgControl, IFGXTapSupported, IFGXNotificationObserver, IFGXNotificationObservable)</code>
+
<syntaxhighlight lang="Delphi">TfgCustomEdit = class (TfgControl, IFGXTextable)</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.Edit.TfgCustomEdit|TfgCustomEdit]]</span></p>
 +
 
 +
Прямые наследники:
 +
[[FGX.AutoCompleteEdit.TfgCustomAutoCompleteEdit|TfgCustomAutoCompleteEdit]], [[FGX.Edit.TfgEdit|TfgEdit]]
 +
 
 +
Непрямые наследники:
 +
[[FGX.AutoCompleteEdit.TfgAutoCompleteEdit|TfgAutoCompleteEdit]], [[FGX.SearchEdit.TfgCustomSearchEdit|TfgCustomSearchEdit]], [[FGX.SearchEdit.TfgSearchEdit|TfgSearchEdit]]
  
 
== Описание ==
 
== Описание ==
  
−
Описание отсутствует.
+
<span style="color:gray">Описание отсутствует.</span>
 +
== Конструкторы ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|}
 +
 
 +
== Методы ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">SelectAll()</code>
 +
<p>Выделяет весь текст. Если тектса нет, то ничего не делает.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ResetSelection()</code>
 +
<p>Сбрасывает текущее выделение текста.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">SetSelection(const AStart: [[Integer]]; const ALength: [[Integer]])</code>
 +
<p>Задает выделение текста длинной <i>ALength</i> и начиная с индекса <i>AStart</i> .</p>
 +
|}
  
−
== Конструкторы ==
+
== Свойства ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionStart: [[Integer]]</code>
 +
 
 +
<p>Индекс начала выделения.</p><div class="info">Индексация начинается с 0.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionLength: [[Integer]]</code>
 +
<p>Длина выделения.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Error: [[string]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TextPromptColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>IconLink: [[FGX.Assets.TfgAssetLink|TfgAssetLink]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Text: [[string]]</code>
 +
<p>Текущий введенный текст.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TextPrompt: [[string]]</code>
 +
<p>Тестовая подсказка отображаемая, когда текст еще не введен.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TextPromptColor: [[TAlphaColor]]</code>
 +
<p>Цвет отображения текстовой подсказки <i>TextPrompt</i> .</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TextPromptColorName: [[TfgAssetName|TfgAssetName]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ContentPadding: [[FGX.Layout.Types.TfgPadding|TfgPadding]]</code>
 +
<p>Отступы от краев компонента до границ отображения содержимого.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>IsPassword: [[Boolean]]</code>
 +
<p>Поле предназначено для ввода пароля?</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>IconName: [[TfgAssetName|TfgAssetName]]</code>
 +
<p>Название ресурса, содержащего картинку, которая будет выводиться слева от поля ввода.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ReadOnly: [[Boolean]]</code>
 +
<p>Запрещается редактировать текст.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>KeyboardType: [[FGX.Text.TfgKeyboardType|TfgKeyboardType]]</code>
 +
<p>Тип используемой клавиатуры, когда поле принимает фокус.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ReturnKeyType: [[FGX.Text.TfgReturnKeyType|TfgReturnKeyType]]</code>
 +
<p>Тип операции, которую сгенерирует клавиатура, когда пользователь нажмет на кнопку Done.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AutocorrectionType: [[FGX.Text.TfgAutocorrectionType|TfgAutocorrectionType]]</code>
 +
<p>Режим автоматической корректировки ошибок, допускаемых при вводе текста.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AutocapitalizationType: [[FGX.Text.TfgAutocapitalizationType|TfgAutocapitalizationType]]</code>
 +
<p>Режим капитализации (первая буква в верхнем регистре) вводимых символов.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>BorderStyle: [[FGX.Edit.TfgEditBorderStyle|TfgEditBorderStyle]]</code>
 +
<p>Стиль отображения рамки поля ввода.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SpellCheckingType: [[FGX.Text.TfgSpellCheckingType|TfgSpellCheckingType]]</code>
 +
<p>Режим проверки правописания текста.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ShowVirtualKeyboardOnFocus: [[FGX.Types.TfgPlatformBoolean|TfgPlatformBoolean]]</code>
 +
<p>Показывать ли виртуальную клавиатуру, когда поле ввода получает фокус?</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectAllOnFocus: [[Boolean]]</code>
 +
<p>Отвечает за то, нужно ли выделять текст в поле ввода при получении фокуса или нет.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>MaxLength: [[Integer]]</code>
 +
<p>Максимально допустимое количество вводимых символов.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Font: [[FGX.Canvas.Types.TfgFont|TfgFont]]</code>
 +
<p>Параметры шрифта отображения текста.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Color: [[TAlphaColor]]</code>
 +
<p>Цвет отображения текста.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ColorName: [[TfgAssetName|TfgAssetName]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColor: [[TAlphaColor]]</code>
 +
<p>Цветовой оттенок поля ввода.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TintColorName: [[TfgAssetName|TfgAssetName]]</code>
 +
 
 +
<p>Ресурс цвета оттенка вкладки.</p><div class="info">Если указан ресурс цвета, то он имеет более высокий приоритет над <i>TintColor</i> . Поэтому именно он и будет использоваться. Если же в ресурсе цвет не указан (Null) или его нет, то будет использоваться <i>TintColor</i> .</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HorzAlign: [[FGX.Text.TfgHorizontalAlignment|TfgHorizontalAlignment]]</code>
 +
<p>Выравнивание текста по горизонтали.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>VertAlign: [[FGX.Text.TfgVerticalAlignment|TfgVerticalAlignment]]</code>
 +
<p>Выравнивание текста по вертикали.</p>
 +
|}
 +
 
 +
== События ==
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
| <code>constructor</code> || <code>Create(AOwner: [[TComponent]])</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanging: [[TNotifyEvent]]</code>
 +
<p>Срабатывает при любом изменении строки поиска.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanged: [[TNotifyEvent]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnReturnKeyPressed: [[TfgReturnKeyPressedEvent|TfgReturnKeyPressedEvent]]</code>
 +
 
 +
<p>Срабатывает, когда пользователь нажимает на кнопку <i>Return</i> . Вид этой кнопки задается через <i>ReturnKeyType</i> .</p><p>В зависимости от значения <i>ReturnKeyType</i> , поле ввода может выполнять дополнительные действия. Например, если <i>ReturnKeyType = Next</i> , то при нажатии на кнопку <i>Return</i> поле ввода сменит фокус на следующее поле ввода.</p><div class="info">Если вы не хотите, чтобы поле ввода выполняло дополнительное действие, передайте в параметре <i>AHandle = True</i> .</div>
 +
|}
  
 +
== Константы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultIsPassword: [[Boolean]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultReadOnly: [[Boolean]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultKeyboardType: [[FGX.Text.TfgKeyboardType|TfgKeyboardType]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultSpellCheckingType: [[FGX.Text.TfgSpellCheckingType|TfgSpellCheckingType]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultMaxLength: [[Integer]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultTextColor: [[Integer]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultAutocorrectionType: [[FGX.Text.TfgAutocorrectionType|TfgAutocorrectionType]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultAutocapitalizationType: [[FGX.Text.TfgAutocapitalizationType|TfgAutocapitalizationType]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultReturnKeyType: [[FGX.Text.TfgReturnKeyType|TfgReturnKeyType]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultTintColor: [[TAlphaColor]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultTextPromptColor: [[TAlphaColor]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultShowVirtualKeyboardOnFocus: [[FGX.Types.TfgPlatformBoolean|TfgPlatformBoolean]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultVertAlign: [[FGX.Text.TfgVerticalAlignment|TfgVerticalAlignment]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultHorzAlign: [[FGX.Text.TfgHorizontalAlignment|TfgHorizontalAlignment]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultSelectAllOnFocus: [[Boolean]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultBorderStyle: [[FGX.Edit.TfgEditBorderStyle|TfgEditBorderStyle]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
|}

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

Delphi 

TfgCustomEdit = class (TfgControl, IFGXTextable)

TComponent -> TfgControl -> TfgCustomEdit

Прямые наследники: TfgCustomAutoCompleteEdit, TfgEdit

Непрямые наследники: TfgAutoCompleteEdit, TfgCustomSearchEdit, TfgSearchEdit

Описание

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

Конструкторы

constructor
Create(AOwner: TComponent)

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

Методы

procedure
SelectAll()

Выделяет весь текст. Если тектса нет, то ничего не делает.

procedure
ResetSelection()

Сбрасывает текущее выделение текста.

procedure
SetSelection(const AStart: Integer; const ALength: Integer)

Задает выделение текста длинной ALength и начиная с индекса AStart .

Свойства

property
SelectionStart: Integer

Индекс начала выделения.

Индексация начинается с 0.
property
SelectionLength: Integer

Длина выделения.

property
Error: string

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

property
ColorLink: TfgAssetColorLink

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

property
TextPromptColorLink: TfgAssetColorLink

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

property
TintColorLink: TfgAssetColorLink

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

property
IconLink: TfgAssetLink

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

property
Text: string

Текущий введенный текст.

property
TextPrompt: string

Тестовая подсказка отображаемая, когда текст еще не введен.

property
TextPromptColor: TAlphaColor

Цвет отображения текстовой подсказки TextPrompt .

property
TextPromptColorName: TfgAssetName

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

property
ContentPadding: TfgPadding

Отступы от краев компонента до границ отображения содержимого.

property
IsPassword: Boolean

Поле предназначено для ввода пароля?

property
IconName: TfgAssetName

Название ресурса, содержащего картинку, которая будет выводиться слева от поля ввода.

property
ReadOnly: Boolean

Запрещается редактировать текст.

property
KeyboardType: TfgKeyboardType

Тип используемой клавиатуры, когда поле принимает фокус.

property
ReturnKeyType: TfgReturnKeyType

Тип операции, которую сгенерирует клавиатура, когда пользователь нажмет на кнопку Done.

property
AutocorrectionType: TfgAutocorrectionType

Режим автоматической корректировки ошибок, допускаемых при вводе текста.

property
AutocapitalizationType: TfgAutocapitalizationType

Режим капитализации (первая буква в верхнем регистре) вводимых символов.

property
BorderStyle: TfgEditBorderStyle

Стиль отображения рамки поля ввода.

property
SpellCheckingType: TfgSpellCheckingType

Режим проверки правописания текста.

property
ShowVirtualKeyboardOnFocus: TfgPlatformBoolean

Показывать ли виртуальную клавиатуру, когда поле ввода получает фокус?

property
SelectAllOnFocus: Boolean

Отвечает за то, нужно ли выделять текст в поле ввода при получении фокуса или нет.

property
MaxLength: Integer

Максимально допустимое количество вводимых символов.

property
Font: TfgFont

Параметры шрифта отображения текста.

property
Color: TAlphaColor

Цвет отображения текста.

property
ColorName: TfgAssetName

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

property
TintColor: TAlphaColor

Цветовой оттенок поля ввода.

property
TintColorName: TfgAssetName

Ресурс цвета оттенка вкладки.

Если указан ресурс цвета, то он имеет более высокий приоритет над TintColor . Поэтому именно он и будет использоваться. Если же в ресурсе цвет не указан (Null) или его нет, то будет использоваться TintColor .
property
HorzAlign: TfgHorizontalAlignment

Выравнивание текста по горизонтали.

property
VertAlign: TfgVerticalAlignment

Выравнивание текста по вертикали.

События

event
OnChanging: TNotifyEvent

Срабатывает при любом изменении строки поиска.

event
OnChanged: TNotifyEvent

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

event
OnReturnKeyPressed: TfgReturnKeyPressedEvent

Срабатывает, когда пользователь нажимает на кнопку Return . Вид этой кнопки задается через ReturnKeyType .

В зависимости от значения ReturnKeyType , поле ввода может выполнять дополнительные действия. Например, если ReturnKeyType = Next , то при нажатии на кнопку Return поле ввода сменит фокус на следующее поле ввода.

Если вы не хотите, чтобы поле ввода выполняло дополнительное действие, передайте в параметре AHandle = True .

Константы

const
DefaultIsPassword: Boolean

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

const
DefaultReadOnly: Boolean

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

const
DefaultKeyboardType: TfgKeyboardType

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

const
DefaultSpellCheckingType: TfgSpellCheckingType

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

const
DefaultMaxLength: Integer

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

const
DefaultTextColor: Integer

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

const
DefaultAutocorrectionType: TfgAutocorrectionType

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

const
DefaultAutocapitalizationType: TfgAutocapitalizationType

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

const
DefaultReturnKeyType: TfgReturnKeyType

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

const
DefaultTintColor: TAlphaColor

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

const
DefaultTextPromptColor: TAlphaColor

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

const
DefaultShowVirtualKeyboardOnFocus: TfgPlatformBoolean

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

const
DefaultVertAlign: TfgVerticalAlignment

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

const
DefaultHorzAlign: TfgHorizontalAlignment

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

const
DefaultSelectAllOnFocus: Boolean

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

const
DefaultBorderStyle: TfgEditBorderStyle

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

Источник — http://docs.fgx-native.com/index.php?title=FGX.Edit.TfgCustomEdit&oldid=27780