Назначение


Компонент служит для вывода записей из БД в древовидном виде.



Класс: TdbTreeView



Свойства компонента

 Свойство

 Тип

 Описание

 dbFilter

 String

 Позволяет задать дополнительный фильтр, который будет использован для заполнения компонента данными из БД. Например: tablename.fieldname = 1

 dbForeignKey

 String

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

 dbFieldParentID

 String

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

 dbGetSqlStatement

 String

 Свойство позволяет получить последний SQL запрос, который использовался для заполнения компонента данными из БД.

 dbIncremSearch

 String

 Позволяет указать имя кнопки на текущей форме с действием "Поиск" или "SQL запрос", которая будет автоматически нажиматься при вводе текста пользователем для моментального поиска.

 dbItemID

 Integer

 Идентификатор выбранной записи в компоненте. Идентификатор соотвествует полю id в базе данных.

 dbListFieldsNames

 String

 Содержит названия заголовков для столбцов разделенных через запятую.

 dbPopupMenu

 TPopupMenu

 Свойство обеспечивает доступ к всплыващему меню компонента. Подробней.

 sqlValue

 String

 Возвращает id выбранной записи в компоненте для использования в SQL запросах. В случае пустого значение, вернет строку NULL

 пример: SQLExecute ('INSERT INTO tablename (fieldname) VALUES ('+Form1.TableGrid1.sqlValue+')');

 BorderStyle

 TBorderStyle

 Определяет наличие бордюра у компонента. Доступные значения: bsSingle, bsNone

 CanFocus

 Boolean

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

 Canvas

 TCanvas

 Класс, позволяющий рисовать на компоненте. Подробней.

 Cell[x,y]

 TCell

 Свойство для доступа к дополнительным свойствам указанной ячейке компонента (x - колонка, y - строка). Подробней.

 Cells[x,y]

 String

 Свойство для доступа к текстовому содержимому ячейки.

 ClientWidth

 Integer

 Ширина клиенсткой части компонента (т.е. без учета бордюров).

 ClientHeight

 Integer

 Высота клиенсткой части компонента (т.е. без учета бордюров).

 Color

 TColor

 Цвет фона компонента. Подробней.

 Columns

 TNxColumns

 Свойство для доступа к дополнительным свойствам и методам колонок. Подробней.

 Columns[i]

 TNxCustomColumn

 Свойство для доступа к свойствам указанной колонки. Подробней.

 Cursor

 TCursor

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

 Enabled

 Boolean

 Определяет доступность компонента для пользователя.

 Expanded [Index: Integer]

 Boolean

 Свойство определяет состояние узла (развернут или свернут).

 FixedCols

 Integer

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

 Focused

 Boolean

 Проверяет, имеет ли компонент фокус ввода. Только для чтения.

 Font

 TFont

 Позволяет задать имя, размер, цвет и стиль шрифта. Подробней.

 HeaderSize

 Integer

 Высота заголовков.

 Hint

 String

 Текст всплывающей подсказки, см. также ShowHint

 HorzScrollBar

 TNxScrollBar

 Свойство для доступа к дополнительным свойствам и методам полосы прокрутки. Подробней.

 LastAddedRow

 Integer

 Свойство возвращает индекс последней добавленной строки. Только для чтения.

 Name

 String

 Уникальное имя компонента на форме.

 Options

 TGridOptions

 Дополнительные настройки компонента. Подробней.

 Parent

 TWinControl

 Родительский компонент, на котором расположен данный компонент.

 RowCount

 Integer

 Содержит количество строк в компоненте.

 RowSize

 Integer

 Высота строк.

 Row[i]

 TRow

 Доступ к дополнительным свойствам строки по ее индексу. Подробней.

 RowVisible[i]

 Boolean

 Определяет видимость строки по ее индексу.

 Selected[i]

 Boolean

 Выделяет указанную строку.

 SelectedRow

 Integer

 Определяет выделенную строку.

 SelectedColumn

 Integer

 Содержит индекс выделенной колонки.

 SelectedCount

 Integer

 Возвращает количество выделенных строк.

 ShowHint

 Boolean

 Определяет, показывать ли всплывающую подсказку, см. также Hint

 TabOrder

 Integer

 Определяет порядковый номер компонента в очереди обхода фокусом ввода компонентов, находящихся на Форме, при нажатии клавиши Tab

 TabStop

 Boolean

 Определяет, будет ли компонент получать фокус, при нажатии клавиши Tab на форме

 Tag

 Integer

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

 TagString

 String

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

 VertScrollBar

 TNxScrollBar

 Свойство для доступа к дополнительным свойствам и методам полосы прокрутки. Подробней.

 Visible

 Boolean

 Определяет видимость компонента.

 VisibleRows

 Integer

 Возвращает количество видимых строк.

 Left

 Integer

 X координата компонента на форме.

 Top

 Integer

 Y координата компонента на форме.

 Width

 Integer

 Ширина компонента.

 Height

 Integer

 Высота компонента.






Методы компонента

 Метод

 Описание

 function dbIndexToID (index: Integer): integer

 Позволяет получить идентификатор записи (поле БД id), указав порядковый номер строки.

 function dbUpdate: String

 Принудительно обновляет данные в компоненте. Как правило компонент обновляет данные автоматически, если данные были изменены.  Также возвращает SQL запрос, который был использован для обращения к БД.

 function AddRow (Count: Integer = 1): Integer

 Добавляет указанное количество строк в компонент. При этом данные в БД не добавляются.

 procedure AddChildRow (const Index: Integer; Position: TChildRowPosition)

 Добавляет дочернюю ветку для указанной строки. Данные в БД при этом не добавляются. Доступные значения параметра Position: crFirst, crLast

 procedure BeginUpdate

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

 procedure BestFitColumns (BestFitMode: TBestFitMode = bfCells)

 Метод автоматически подбирает ширину колонок. Подробней.

 procedure BestFitRow (const Index: Integer)

 Метод автоматически подбирает высотку строки, в зависимости от содержимого ячеек в данной строке. Подробней.

 procedure CalculateFooter (VisibleOnly: Boolean = False)

 Принудительно пересчитывает результаты в подвале компонента.

 procedure ClearRows

 Очищает содержимое компонента.

 procedure CollapseAll

 Сворачивает все узлы дерева.

 procedure DeleteRecord (id: integer)

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

 procedure DeleteRow (Index: Integer)

 Удаляет указанную строку. При этом запись из БД не удаляется.

 function ExportToExcel (FileName: string = ''; ExcelVisible: boolean = True; FirsRowColumns: boolean = True): Variant

 Делает экспорт данных из компонента в Excel. Также возвращает OLE объект Excel, для последующей работы с данными.

 function ExportToLibreCalc (FirsRowColumns: boolean = True): Boolean

 Делает экспорт данных из компонента в OpenOffice (LibreOffice).

 procedure EndUpdate

 Смотри BeginUpdate

 procedure ExpandNode (Index: Integer)

 Раскрывает указанный узел дерева

 procedure ExpandAll

 Раскрывает все узлы дерева

 function GetRowAtPos (X, Y: Integer): Integer

 Позволяет получить индекс строки по координатам.

 function GetColumnAtPos (X, Y: Integer): TNxCustomColumn

 Позволяет получить ссылку на колонку по координатам.

 function GetChildCount (const Index: Integer; Recurse: Boolean = True): Integer

 Возвращает количество дочерних записей для указанной строки в параметре Index.

 function GetFirstChild (const Index: Integer): Integer

 Возвращает индекс первой дочерней строки относительно строки указанной в параметре Index.

 function GetLastChild (const Index: Integer): Integer

 Возвращает индекс последней дочерней строки относительно строки указанной в параметре Index.

 function GetLevel (const Index: Integer): Integer

 Возвращает уровень вложенности указанной строки.

 function GetNextSibling (const Index: Integer): Integer

 Возвращает индекс следующей строки, расположенной на этом же уровне. Если следующей строки на этом же уровне нет, то возвращает -1.

 function GetParent (const Index: Integer): Integer

 Возвращает индекс строки, которая является родительской.

 function GetPrevSibling (const Index: Integer): Integer

 Возвращает индекс предыдущей строки, расположенной на этом же уровне. Если предыдущей строки на этом же уровне нет, то возвращает -1.

 function HasChildren (const Index: Integer): Boolean

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

 procedure InsertRow (Pos: Integer; Count: Integer = 1)

 Вставляет новую строку в указанную позицию. При этом данные в БД не добавляются.

 procedure LoadFromTextFile (const FileName: String; Separator: Char = ','; MultiLineSeparator: Char = '|'; StartRow: Integer = 0)

 Загружает данные текстового файла в компонент. При этом данные не попадают в базу данных. Используемая кодировка загружаемого файла должны быть Unicode (UCS-2 Little Endian)

 procedure MoveRow (FromPos, ToPos: Integer)

 Перемещает строку. При этом изменения в БД не производятся.

 procedure SaveToHtml (FileName: String; SaveHeaders: boolean = True; AllRows: boolean = False; CreateStyleSheet: boolean = True; SaveFooter: boolean = False; SaveCaption: boolean = False)

 Сохраняет содержимое компонента в HTML файл.

  procedure SaveToTextFile (const FileName: String; Separator: Char = ','; MultiLineSeparator: Char = '|')

 Сохраняет содержимое компонента в текстовый файл. Используемая кодировка файла Unicode (UCS-2 Little Endian).

 procedure ScrollToRow (index: integer)

 Перемещает скролл в таблице, чтобы была видна указанная строка.

 procedure SelectAll

 Выделяет все строки в компоненте. Для работы метода, необходимо чтобы в свойстве Options присутствовали значения goMultiSelect и goSelectFullRow.

 procedure SelectRange (FromRow, ToRow: Integer; Value: Boolean)

 Выделяет (либо снимает выделение, если Value = False) указанный диапазон строк.

 procedure SetFocus

 Устанавливает фокус ввода для компонента.

 procedure SwapRows (FromPos, ToPos: Integer)

 Меняет строки местами.






События компонента

 Событие

 Описание

 OnAfterSort (Sender: TObject; ACol: Integer)

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

 OnCellClick (Sender: TObject; ACol, ARow: Integer)

 Срабатывает, когда пользователь кликнул по ячейке. Подробней.

 OnCellDoubleClick (Sender: TObject; ACol, ARow: Integer)

 Срабатывает, когда пользователь сделал двойной клик по ячейке.

 OnChange (Sender: TObject)

 Срабатывает после того, как компонент был заполнен данными из базы данных.

 OnClick (Sender: TObject)

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

 OnColumnResize (Sender: TObject; ACol: Integer)

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

 OnDoubleClick (Sender: TObject)

 Срабатывает при двойном клике по компоненту

 OnEnter (Sender: TObject)

 Срабатывает при получении компонентом фокуса ввода.

 OnExit (Sender: TObject)

 Срабатывает при потере компонентом фокуса ввода.

 OnExpand (Sender: TObject; ARow: Integer)

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

 OnFooterClick (Sender: TObject; ACol: Integer)

 Срабатывает, когда пользователь кликнул по футеру (подвал).

 OnHeaderClick (Sender: TObject; ACol: Integer)

 Срабатывает, когда пользователь кликнул заколовку колонки.

 OnHeaderDoubleClick (Sender: TObject; ACol: Integer)

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

 OnKeyDown (Sender: TObject; var Key: Word; Shift, Alt, Ctrl: boolean)

 Срабатывает при нажатии на любую кнопку клавиатуры.

 OnKeyPress (Sender: TObject; var Key: Char)

 Срабатывает при нажатии на кнопку клавиатуры. Работает только для печатных символов.

 OnKeyUp (Sender: TObject; var Key: Word; Shift, Alt, Ctrl: boolean)

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

 OnLoadProgress (Sender: TObject; ACol, ARow: Integer)

 Срабатывает при загрузке текстового файла в компонент с помощью метода LoadFromTextFile

 OnMouseDown (Sender: TObject; MouseLeft, MouseRight, MouseMiddle: boolean; Shift, Alt, Ctrl: boolean; X, Y: Integer)

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

 OnMouseEnter (Sender: TObject)

 Срабатывает при заходе курсора мыши на компонент.

 OnMouseLeave (Sender: TObject)

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

 OnMouseMove (Sender: TObject; Shift, Alt, Ctrl: boolean; X, Y: Integer)

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

 OnMouseUp (Sender: TObject; MouseLeft, MouseRight, MouseMiddle: boolean; Shift, Alt, Ctrl: boolean; X, Y: Integer)

 Срабатывает в момент отпускания кнопки мыши над компонентом.

 OnResize (Sender: TObject)

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

 OnRowMove (Sender: TObject; FromPos, ToPos: Integer; var Accept: Boolean)

 Cрабатывает, когда пользователь переместил строку на новую позицию. Позволяет отменитиь перемещение. Подробней.

 OnSortColumn (Sender: TObject; ACol: Integer; Ascending: Boolean)

 Срабатывает перед сортировкой колонки.

 OnDropFiles (Sender: TObject; ArrayOfFiles: array of string; X, Y: Integer)

 Срабатывает при попытке перетащить файл из проводника на компонент. Подробней.