Kopia wikimirror

To jest mirror wiki z pascal.chat. Edycja, historia i logowanie są tam.

Grids Reference Page/pl

Deutsch · English · Español · Polski · Русский

Strona referencyjna siatek Grid

Intencje

Ten tekst będzie próbą pokazania użytkownikowi niektórych aspektów komponentów siatek (grids) w Lazarusie. Ma również służyć jako przewodnik dla użytkowników, którzy nigdy dotąd nie używali komponentów siatek (ponieważ doświadczeni użytkownicy zazwyczaj potrzebują jedynie informacji dotyczących nowych funkcji). W niniejszym tekście postaram się zatem osiągnąć następujące cele:

  1. Przedstawić komponenty siatki osobom z niewielkim lub żadnym doświadczeniem w Delphi.
  2. Udokumentować różnice w odniesieniu do komponentów siatek Delphi.
  3. Udokumentować nową funkcjonalność w siatkach Lazarusa.
  4. Utworzyć referencje i przykłady dla tych komponentów.

Wprowadzenie

Siatka (Grid) to komponent, który umożliwia wyświetlanie danych w formacie tabelarycznym. Najbardziej oczywistą cechą siatek jest to, że składają się one z komórek tworzących rzędy i kolumny, podobnie jak w arkuszu kalkulacyjnym.

Ilość typów informacji, które można wyświetlić w siatce, jest różna i zależy głównie od tego, co użytkownik chce pokazać. Ogólnie informacje te składają się z tekstów, kolorów, obrazów lub kombinacji tych trzech.

Biorąc pod uwagę ogromną różnorodność informacji, które można przedstawić, istnieje szereg siatek, których celem jest ułatwienie użytkownikowi pokazania określonych rodzajów informacji. Na przykład istnieje siatka przeznaczona do wyświetlania tekstu: StringGrid. Dokumentację dla tej siatki można znaleźć tutaj

Drzewo dziedziczenia

text
                     TCustomControl
                             |
                             |
                        TCustomGrid
                             |
               +-------------+------------+
               |                          |
         TCustomDrawGrid             TCustomDbGrid
               |                          |
      +--------+--------+                 |
      |                 |              TDBGrid
  TDrawGrid      TCustomStringGrid                
                        |
                        |
                   TStringGrid

Pierwszy przykład

Ponieważ jednym z celów tej strony jest pomoc osobom z niewielką lub żadną wcześniejszą wiedzą o Lazarusie, zróbmy wprowadzający przykład użycia siatek. Dlaczego nie, stwórzmy tradycyjny przykład „Witaj Świecie!” (ang. "Hello World") za pomocą komponentu TStringGrid.

  1. Stwórz nową aplikację.
    • Z menu głównego wybierz: Projekt->Nowy projekt...
    • W oknie dialogowym Utwórz nowy projekt wybierz Aplikacja i naciśnij „OK”
    • Zostanie wyświetlony nowy pusty formularz.
  2. Umieść siatkę (grid) na formularzu
    • Z palety komponentów wybierz zakładkę „Additional”
    • Kliknij ikonę TStringGrid
    • Kliknij formularz w lewym górnym rogu. Pojawi się nowa pusta siatka.
  3. Umieść przycisk na formularzu
    • Z palety komponentów wybierz zakładkę „Standard”
    • Kliknij ikonę TButton
    • Kliknij na pusty obszar formularza. Pojawi się nowy przycisk.

Kliknij dwukrotnie przycisk z kroku 3 i zapisz następujący kod w module obsługi przycisku kliknięcia:

#*

pascal
StringGrid1.Cells[1,1] := 'Witaj Świecie!';
  1. Uruchom program, klikając ikonę odtwarzania
    • po naciśnięciu przycisku Button1 w komórce w kolumnie 1 i wierszu 1 powinien pojawić się tekst „Witaj Świecie!”. (zwróć uwagę, że indeksy lewej kolumny i górnego wiersza są równe 0)

Różnice pomiędzy komponentami siatki Lazarusa i Delphi

Obecne elementy siatek różnią się od siatek Delphi na kilka sposobów. Jest to spowodowane głównie tym, że kiedy po raz pierwszy opracowano siatki dla Lazarusa, były one tworzone od zera bez żadnych prób uczynienia ich w pełni kompatybilnymi z Delphi.

Na późniejszym etapie kompatybilność z siatkami Delphi stała się pożądanym celem, a siatki Lazarus zaczęły być bardziej zgodne z interfejsem sieci Delphi. Jednak nawet to zostało zrobione bez próby dopasowania każdej właściwości lub metody siatki Lazarusa do swojego odpowiednika w Delphi. Ponadto (ponieważ wewnętrzne elementy siatki Lazarusa bardzo różnią się od wewnętrznych elementów siatki Delphi) niektóre funkcje Delphi nie są dostępne lub muszą być emulowane w inny sposób w siatce Lazarusa niż w przypadku siatki Delphi. Osiągnęliśmy większą kompatybilność z Delphi w miarę ewolucji siatek Lazarusa i jest to pożądane.

Różnice

Znane różnice wymieniono poniżej (kolejność nie ma znaczenia).

Nowe funkcje

Sposoby na to, by siatka Lazarus była bardziej zgodna z Delphi

Oto lista właściwości i korekt, które mogą być wykonane w celu dostosowania wyglądu lub zachowania komponentów grids Lazarusa do tych z Delphi. Korekty te odnoszą się do nowo utworzonej siatki. Wpisy z etykietą [Kod] należy wykonać w kodzie, a z etykietą [Projekt] można zmieniać w czasie projektowania.

Możesz sprawić, by siatka Lazarusa wyglądała i zachowywała się tak, jak jej odpowiednik w Delphi. Poniżej wymienione są ustawienia właściwości, które pozwolą to osiągnąć. Te dostosowania są oparte na nowo utworzonej siatce. Wpisy oznaczone jako [Kod] należy ustawić w kodzie, wpisy [Projekt] można zmienić w czasie projektowania.

Charakterystyka siatek

Informacja

Punktem wyjścia dla referencji o TCustomGrid, TDrawGrid, TCustomDrawGrid, TCustomStringGrid i TStringGrid jest referencje modułu Grids.pas

Natomiast dla TCustomDBGrid i TDBgrid jest referencje modułu DBGrids.pas

Zazwyczaj jakichkolwiek informacje o komponentach grids dla Delphi powinny pomóc nam także w Lazarusie (ale nie zapominajmy o tych kilku różnicach pomiędzy Delphi i Lazarusem, które są udokumentowane); przy czym traktuj takie dane jako tymczasowe źródło informacji, które nie zawsze będą działały tak samo jak w Delphi.

TODO: Dalsza część tego rozdziału zniknie, a jego zawartość zostanie przeniesiona do referencje modułu Grids.pas

TCustomGrid

Wszystko zobaczysz w: Referencje TCustomGrid

Właściwość AllowOutboundEvents

Właściwość chroniona w klasie TCustomGrid oraz publiczna w klasie TCustomDrawGrid i klasach potomnych. Zwykle, gdy użytkownik kliknie punkt nad pustą przestrzenią za komórkami (na przykład, jeśli siatka ma trzy wiersze, ale użytkownik kliknie wyimaginowany czwarty wiersz), komórka, w której aktualnie znajduje się fokus, przesunie się do komórki najbliższej punktu, który właśnie kliknął. Nazywamy to wydarzeniem wychodzącym. Wartość domyślna to True, ponieważ tak właśnie działa siatka od samego początku. Ta właściwość została dodana, aby symulować zachowanie Delphi, gdy zdarzenia wychodzące nie są dostępne, więc aby umożliwić zgodność z Delphi, ustaw tę właściwość na False.

Właściwość Columns

Lazarus zawiera właściwość columns w siatkach TStringGrid i TDrawGrid. Ta właściwość dodaje to, co nazywamy kolumnami niestandardowymi. Kolumny niestandardowe to zbiór obiektów, które przechowują właściwości, które mają zastosowanie do całych kolumn, na przykład tytuły kolumn (w przypadku StringGrid zastąpi wartość określoną w odpowiedniej właściwości Cells[ColumnIndex, RowTitle]), wyrównanie tekstu, kolor tła, preferowany edytor itp.

Kolumny niestandardowe dodają dodatkowe właściwości lub zastępują domyślne wartości właściwości w normalnych kolumnach siatki. Ponadto, wartość grid.ColCount może się zwiększyć lub zmniejszyć w celu uwzględnienia liczby niestandardowych kolumn dołączanych do siatki. A to oznacza, że grid.ColCount = grid.FixedCols + grid.Columns.Count.

Na przykład, jeśli mamy siatkę bazową z ColCount := 5 i FixedCols := 2 i wykonamy:

Z tego możemy wywnioskować, że:

W czasie projektowania w Inspektorze obiektów użytkownik może uzyskać dostęp do właściwości columns, aby wywołać edytor kolumn. Stamtąd można dodawać, usuwać lub modyfikować niestandardowe kolumny. Edytor wyświetla listę aktualnych kolumn niestandardowych; wybierając elementy z tej listy, inspektor obiektów zostaje wypełniony właściwościami dostępnymi dla każdej kolumny. Lista niestandardowych kolumn jest również dostępna w widoku drzewa komponentów Inspektora obiektów, gdzie kolumny można dodawać, usuwać lub modyfikować. Pojawiają się na niższym poziomie pod siatką kontenerów.

W czasie wykonywania programu, kolumny można modyfikować za pomocą kodu w następujący sposób:

pascal
  var
    c: TGridColumn;
  begin
    // dodaj niestandardową kolumnę siatki
    c := Grid.Columns.Add;
    // modyfikuj kolumnę
    c.title.caption := 'Price';       // Ustaw tytuły kolumn
    c.align := taRightJustify;        // Wyrównaj zawartość kolumny do prawej
    c.color := clMoneyGreen;          // Zmień domyślny kolor na clMoneyGreen
    c.Index := 0;                     // Niech to będzie pierwsza kolumna
    // uzyskać dostęp do istniejącej kolumny
    grid.columns[0].Width := 60;      // Zmień szerokość kolumny 0 na 60 pikseli
    // usuń istniejącą kolumnę
    grid.columns.delete(0);           // Usuń kolumnę 0
    ....
  end;

Dodatkowo, podczas korzystania z niestandardowych kolumn, siatki nie pozwalają na bezpośrednią modyfikację grids.colcount; dodawanie lub usuwanie kolumn powinno odbywać się za pomocą właściwości columns. Wyjaśnienie jest takie, że istnieje niespójność w stopniowym usuwaniu niestandardowych kolumn za pomocą ColCount, gdy ColCount osiągnie FixedCols, siatka nie ma więcej niestandardowych kolumn. Jeśli teraz zwiększymy ColCount, nowa kolumna nie będzie kolumną niestandardową, ale normalną.

Obecnie nie ma planów, aby siatki wykorzystywały tylko kolumny niestandardowe.

Właściwość AutoFillColumns

Często siatki są szersze niż pozioma przestrzeń potrzebna kolumnom - pozostawia to nieprzyjemny pusty obszar po prawej stronie ostatniej kolumny. Siatki LCL zapewniają mechanizm rozszerzania szerokości określonych kolumn w taki sposób, że puste miejsce jest wypełniane automatycznie.

W tym celu należy dodać Columns zgodnie z opisem powyżej lub przez ustawienie właściwości ColCount oraz właściwości siatki AutoFillColumns, która musi być ustawiona na True. Każda kolumna ma właściwość SizePriority. Gdy ma wartość 0, szerokość kolumny jest pobierana z właściwości Width kolumny. Ale gdy ma wartość niezerową, szerokość kolumny jest dostosowywana do średniego dostępnego rozmiaru pozostałego dla wszystkich kolumn z niezerowym SizePriority.

Procedura SaveToFile(AFileName: String)

Zapisuje siatkę do pliku XML. Właściwość SaveOptions określa, co dokładnie ma zostać zapisane:

pascal
type
  TGridSaveOptions = (
    soDesign,             // Zapisz strukturę siatki (liczba kolumn/wierszy i opcje - Options)
    soAttributes,         // Zapisz atrybuty siatki (czcionka - Font, pędzel - Brush, styl tekstu TextStyle)
    soContent,            // Zapisz zawartość siatki (tekst w StringGrid)
    soPosition            // Zapisz kursor siatki i pozycję zaznaczenia
  );
  TSaveOptions = set of TGridSaveOptions;

Procedura LoadFromFile(AFileName: String)

Ładuje plik XML utworzony przez SaveToFile. Ponownie, SaveOptions określają, co dokładnie ma zostać załadowane z pliku.

TCustomDBGrid

TCustomDBGrid jest podstawą dla TDBGrid.

Nie ujawniają właściwości Col i Row. Aby przejść do określonej kolumny, użyj np. właściwość SelectedIndex.

Ciekawą metodą publiczną jest AutoAdjustColumns.

Procedura AutoAdjustColumns

Ta procedura ustawia szerokość kolumny na rozmiar najszerszego znalezionego tekstu. Można go używać po załadowaniu zestawu danych/ustawieniu go jako Aktywny - Active.

Jednak w przeciwieństwie do TCustomStringGrid.AutoAdjustColumns (patrz poniżej), spowoduje to ustawienie bardzo szerokich kolumn, chyba że masz włączoną właściwość dgAutoSizeColumns.

Procedura InplaceEditor

Zobacz przykład z błędu 23103 - i wstaw wyjaśnienie, co robi/dlaczego jest to potrzebne. Weryfikuje wartości wejściowe? Zmienia to, co jest wyświetlane?

pascal

procedure TForm1.DBGrid1KeyPress(Sender: TObject; var Key: char);
var
  S: String;
begin
  if (Key in [',','.']) then
  begin
    //w przeciwieństwie do Delphi nie wszystkie edytory InPlaceEditors są edytorami typu string, więc sprawdź!
    if (DBGrid1.InplaceEditor is TStringCellEditor) then
    begin
      S := TStringCellEditor(DBGrid1.InplaceEditor).EditText;
      if Pos(',',S) > 0 then
        Key := #0
      else
        Key := ',';
    end;
  end;
end;

TCustomStringGrid

Klasa TCustomStringGrid służy jako podstawa dla klasy TStringGrid. Może być używana dla pochodnych komponentów TStringGrid, które chcą ukryć opublikowane właściwości.

Następujące właściwości lub metody są publiczne i są również dostępne dla TStringGrid.

Zobacz pełną dokumentację TCustomStringGrid

Procedura AutoSizeColumn(aCol: Integer)

Ta procedura dostosowuje szerokość kolumny do rozmiaru najszerszego tekstu, jaki znajduje się pośród wszystkich wierszy kolumny aCol. Wskazówka: zobacz opcję goDblClickAutoSize, która umożliwia automatyczną zmianę szerokości kolumny, gdy użyjemy podwójnego kliknięcia na obramowaniu tejże kolumny.

Procedura AutoAdjustColumns lub AutoSizeColumns

Automatycznie zmienia szerokość wszystkich kolumn, dopasowując je do najdłuższego tekstu w każdej kolumnie. Jest to szybka metoda zastosowania funkcji AutoSizeColumn() dla każdej kolumny w siatce.

Procedura Clean; overload;

Czyści wszystkie komórki siatki, także te stałe (typu fixed).

Procedura Clean(CleanOptions: TGridZoneSet); overload;

Czyści wszystkie komórki w siatce wskazane w parametrze CleanOptions. Zobacz TGridZoneSet aby uzyskać więcej informacji. Poniżej kilka przykładów:

Procedura Clean(StartCol,StartRow,EndCol,EndRow: integer; CleanOptions:TGridZoneSet); overload;

Wykonuje to samo co Clean(CleanOptions:TGridZoneSet), ale jej działanie ograniczone jest obszarem określonym parametrami StartCol, StartRow, EndCol i EndRow. Przykład:

Procedura Clean(aRect: TRect; CleanOptions: TGridZoneSet); overload;

Wykonuje to samo co Clean(StartCol,StartRow,EndCol,EndRow, CleanOptions), ale przy pomocy TRect zamiast wskazywania pojedynczych współrzędnych komórek. Przydatne do czyszczenia zaznaczonego obszaru: grid.Clean(Grid.Selection,[]);

==== Procedura SaveToCSVFile(AFileName: string; ADelimiter:Char=','; WithHeader:boolean=true); ====

Zapisuje zawartość siatki w pliku w formacie tekstowym, gdzie wartości są rozdzielone przecinkami (CSV) (dodanym w Lazarus r32179).

Argument AFilename określa nazwę pliku, w którym zostanie zapisana zawartość. Jeśli plik istnieje, zawartość zostanie nadpisana. Jeśli nie istnieje, plik zostanie utworzony.

ADelimiter (argument opcjonalny) jest używany do dostarczenia niestandardowego separatora, jeśli jest to wymagane. Domyślnie tworzony jest format CSV (tzn. ADelimiter:=',';) dla pliku rozdzielanego tabulatorami ADelimiter powinien mieć wartość #9.

Parametr WithHeader służy do określenia, czy „nagłówek wiersza” powinien zostać uwzględniony, czy nie. Nagłówek wiersza to lista nazw pól na początku pliku wyjściowego; jego zawartość pochodzi z ostatniego stałego (Fixed) wiersza w siatce. Istnieje wyjątek od tej reguły: jeśli siatka zawiera niestandardowe kolumny, zawartość nagłówka wiersza pochodzi z niestandardowych tytułów kolumn, a nie ze stałych komórek wiersza.

Jeśli WithHeader ma wartość True, a siatka nie zawiera stałego wiersza ani niestandardowych kolumn, zawartość nagłówka wiersza zostanie pobrana z pierwszego wiersza w siatce.

Normalne wyjście danych CSV rozpocznie się od pierwszego niestałego (Non-Fixed) wiersza w siatce.

==== Procedura LoadFromCSVFile(AFileName: string; ADelimiter:Char=','; WithHeader:boolean=true); ====

Wczytuje zawartość siatki z pliku w formacie CSV (dodanym w Lazarus r32179).

Kolumny będą dodawane lub usuwane do lub z siatki w zależności od potrzeb, zgodnie z liczbą pól zawartych w każdym wierszu pliku CSV. Wczytanie pliku CSV nie zmieni liczby stałych (Fixed) wierszy, które już istniały w siatce.

Argument AFileName określa nazwę pliku źródłowego z zawartością CSV.

Opcjonalny parametr ADelimiter może być użyty do określenia innego separatora lub ogranicznika. Przykład: dla pliku rozdzielanego tabulatorami, ADelimiter powinno mieć wartość #9. Innym popularnym formatem pliku jest plik rozdzielany średnikami, gdzie ADelimiter powinien być ;

Parametr WithHeader służy do określenia, czy pierwszy wiersz w pliku CSV powinien być traktowany jako „wiersz nagłówka”, czy nie. Jeśli siatka ma ustalone wiersze i WithHeader ma wartość True, nagłówki kolumn dla ostatniego stałego (Fixed) wiersza zostaną pobrane z wiersza nagłówka. Należy jednak pamiętać, że jeśli siatka zawiera niestandardowe kolumny, wówczas wiersz nagłówka będzie używany jako źródło dla tytułów kolumn, a niestandardowe tytuły kolumn są zawsze wyświetlane w pierwszym stałym wierszu siatki lub ukryte, jeśli w siatce nie ma ustalonych wierszy.

Jeśli procedura LoadFromCSVFile ma trudności z załadowaniem pliku CSV (np. cudzysłowy lub spacje są nieprawidłowo interpretowane), możesz ręcznie załadować siatkę za pomocą np. CsvDocument... i oczywiście zawsze mile widziana jest łatka dla LoadFromCSVFile.

Właściwość Cols[index: Integer]: TStrings read GetCols write SetCols;

Pobierz/wstaw listę ciągów string z/do kolumny siatki o wskazanym indeksie, począwszy od wiersza o indeksie 0 do wiersza o indeksie RowCount-1.

Przykłady
pascal
Grid.Cols[2] := ListBox1.Items;
pascal
procedure TForm1.FillListBox1;
var 
  StrTempList: TStringList;
begin
  StrTempList := TStringList(Grid.Cols[4]);
  if StrTempList<>nil then begin
    ListBox1.Items.Assign(StrTempList);
    StrTempList.Free;
  end;
end;
Uwagi

Ta właściwość działa inaczej w Lazarusie i w Delphi, gdy pobieramy dane z siatki. W Lazarusie tworzony jest tymczasowy obiekt typu TStringList w celu pobrania zawartości kolumny. Użytkownik jest odpowiedzialny za zwolnienie tego obiektu po użyciu.

Oznacza to także, że zmiany wykonywane w tej zwróconej liście ciągów string nie będą miały żadnego wpływu na zawartość siatki lub układu.

Zobacz powyższy przykład pobrania.

Właściwość Rows[index: Integer]: TStrings read GetRows write SetRows;

Pobierz/ustaw listę ciągów string z/do wiersza siatki o danym indeksie, począwszy od indeksu kolumny 0 do kolumny ColCount-1.

Uwagi

Ta właściwość działa inaczej w Lazarusie i Delphi podczas pobierania danych z siatki. W Lazarusie tworzony jest tymczasowy obiekt typu TStringList do pobierania zawartości wiersza. Obowiązkiem użytkownika jest zwolnienie tego obiektu po użyciu.

Oznacza to również, że jakiekolwiek zmiany w tej zwróconej liście ciągów string nie wpłyną na zawartość ani układu, ani siatki.

Przykłady
pascal
Grid.Rows[2] := ListBox1.Items;
pascal
procedure TForm1.FillListBox1;
var 
  StrTempList: TStringList;
begin
  StrTempList := TStringList(Grid.Rows[4]);
  if StrTempList<>nil then begin
    ListBox1.Items.Assign(StrTempList);
    StrTempList.Free;
  end;
end;
pascal
 // te dwa przykłady nie zadziałają i spowodują wycieki pamięci,
 // ponieważ zwrócone listy ciągów nie są zwalniane
 Grid.Rows[1].CommaText := '1,2,3,4,5';
 Grid.Rows[2].Text := 'a'+#13#10+'s'+#13#10+'d'+#13#10+'f'+#13#10+'g'; 
 
 // naprawienie pierwszego przypadku
 Lst:=TStringList.Create;
 Lst.CommaText := '1,2,3,4,5';
 Grid.Rows[1] := Lst;
 Lst.Free;

Właściwość UseXORFeatures

Właściwość typu Boolean, wartość domyślna: False;

Ta właściwość kontroluje wygląd kropkowanego prostokąta fokusu w siatce (pokazuje się, gdy klikniemy myszką na jakiejś komórce). Gdy ma wartość True, prostokąt jest malowany przy użyciu operacji rastrowej XOR. Dzięki temu możemy zobaczyć prostokąt fokusu bez względu na kolor tła komórek. Gdy ma wartość False, użytkownik może kontrolować kolor kropkowanego prostokąta fokusu za pomocą właściwości FocusColor

Kontroluje również wygląd zmiany rozmiaru kolumny/wiersza. Gdy ma wartość True, linia pokazuje wizualnie rozmiar kolumny lub wiersza, jeśli użytkownik zakończy operację. Gdy ma wartość False, zmiana rozmiaru kolumny lub wiersza zaczyna obowiązywać, gdy użytkownik przeciąga myszą.

TValueListEditor

TValueListEditor to kontrolka (formant) pochodzący z TCustomStringGrid i służy do edycji par typu klucz-wartość.

Właściwość DisplayOptions

Kontroluje różne aspekty wyglądu TValueListEditor.

Właściwość TitleCaptions

Ustawia wartości dla tytułów kolumn (jeśli właściwość DisplayOptions zawiera wartość doColumnTitles). Jeśli DisplayOptions nie ma wartości doColumnTitles, używane są domyślne tytuły.

Właściwość Strings

Zapewnia dostęp do listy ciągów zawierających pary klucz-wartość.
Pary klucz-wartość muszą mieć format typu:
'NazwaKlucza=Wartość'

Właściwość ItemProps

Możesz użyć tej właściwości, aby kontrolować sposób edytowania elementów w kolumnach „Value” (Wartość).
Jest to kontrolowane przez ustawienie właściwości EditStyle i ReadOnly elementu ItemProp.

Właściwość KeyOptions

KeyOptions to zbiór wartości porządkowych TKeyOptions kontrolujących, czy użytkownik może modyfikować zawartość kolumny „Key” (Klucz).

Właściwość DropDownRows

Jeśli edytor komórek jest listą wyboru (ValueEdit1.ItemProps['key1'].EditStyle=esPickList), to ta właściwość ustawia DropDownCount, czyli ilość wierszy wyświetlanej listy. Wartość domyślna to 8.

Funkcja DeleteRow

Usuwa parę Klucz-Wartość wiersza o podanym indeksie, całkowicie usuwając wiersz.

Funkcja InsertRow

Wstawia wiersz w siatce i ustawia parę Klucz-Wartość. Zwraca indeks nowo wstawionego wiersza.

Funkcja IsEmptyRow

Zwraca wartość True, jeśli komórki indeksowanego wiersza są puste (Keys[aRow]=; Values[aRow]=).

Funkcja FindRow

Zwraca indeks wiersza, który ma określoną nazwę klucza.

Funkcja RestoreCurrentRow

Cofa edycję w bieżącym wierszu (jeśli edytor jest nadal aktywny). Dzieje się tak, gdy użytkownik naciśnie klawisz Escape.

Zmienione zachowanie niektórych właściwości pochodzących z TCustomStringGrid

Właściwość Options

Ze względu na charakter TValueListEditor jego właściwość Options ma pewne ograniczenia

Właściwość FixedRows

Może mieć wyłącznie wartość równą 1 (pokaż tytuły kolumn) lub 0 (nie pokazuj tytułów kolumn).

Właściwość ColCount

Może mieć wyłącznie wartość równą 2.

Właściwość Objects

Uwaga! Nie zaleca się używania tej właściwości w ogóle.
Kiedy jakiś (wewnętrzny) kod manipuluje właściwością Strings, zmiany dla Objects zostaną utracone.

Ogólne uwagi dotyczące korzystania z TValueListEditor

Podczas manipulowania zawartością ValueListEditor (siatki) można bezpośrednio manipulować podstawową właściwością Strings.
Pamiętaj jednak, że jeśli to zrobisz, musisz ukryć edytor, w przeciwnym razie ciągi mogą nie być zsynchronizowane z zawartością siatki, którą widzisz na ekranie.\

Jeśli chcesz wstawić lub usunąć wiersze itp., preferowanym sposobem jest użycie metod publicznych z TValueListEditor: DeleteRow(), InsertRow(), MoveRow(), ExchangeRow() lub różnych metod Sort().\

Próba użycia metod z klasy przodka do manipulowania wierszami lub kolumnami (np. Columns.Add) może spowodować awarię.

Zapisywanie i ładowanie zawartości TValueListEditor

Korzystanie z właściwości Strings

Jeśli chcesz tylko zapisać i załadować zawartość TValueListEditor (np. par Klucz/Wartość, a nie układ), możesz użyć metod Strings.SaveToFile i Strings.LoadFromFile.
W przypadku LoadFromFile właściwość RowCount zostanie automatycznie dostosowana.
Również w przypadku LoadFromFile nie są wykonywane żadne kontrole poprawności (więc wiersze, które nie reprezentują pary Klucz/Wartość, zostaną zakończone jako klucze bez wartości).

Korzystanie z TValueList.SaveToFile i TValueList.LoadFromFile

When using SaveToFile and LoadFromFile you get the additional benefits of also being able to save and load the layout, like with other grids.
SaveToFiel will also save information about wether or not the TValueListEditor uses ColumnTitles, and if so, it saves them.\

In contrast to it's ancestors TValueList.LoadFromFile performs sanity checks on the file it tries to read. In particular RowCount must be specified and there cannot be a cell with RowIndex > RowCount or ColumnIndex other than 0 or 1.
If the file does not seem to be a valid TValueListEditor grid file, and exception is raised.\

TValueList.SaveToFile and TValueList.LoadFromFile do not work correctly in Lazarus versions <= 2.1 r62044.

Korzystając z funkcji SaveToFile i LoadFromFile z TValueList, zyskujesz dodatkowe korzyści związane z możliwością zapisywania i ładowania układu, podobnie jak w przypadku innych siatek.
SaveToFile zapisze również informacje o tym, czy TValueListEditor używa ColumnTitles, a jeśli tak, zapisuje je.\

W przeciwieństwie do swoich przodków, TValueList.LoadFromFile sprawdza poprawność pliku, który próbuje odczytać. W szczególności właściwość RowCount musi być określona i nie może istnieć komórka z RowIndex > RowCount lub ColumnIndex innym niż 0 lub 1.
Jeśli plik nie wydaje się być prawidłowym plikiem siatki TValueListEditor, zgłaszany jest wyjątek.\

TValueList.SaveToFile i TValueList.LoadFromFile nie działają poprawnie w wersjach Lazarusa <= 2.1 r62044.

Korzystanie z metod SaveToCSVFile i LoadFromCSV

Te metody nie powinny być obecnie używane, ponieważ w przypadku TValueListEditor są one wadliwe.

Praca z siatkami

Dostosowywanie siatek

Komponenty Grid pochodzą z klasy TCustomControl i nie mają skojarzonego z nią natywnego widżetu, co oznacza, że ​​siatki nie są ograniczone przez wygląd aktualnego motywu interfejsu. Może to być zarówno zaletą, jak i wadą: zwykle programiści chcą stworzyć aplikację o jednolitym wyglądzie. Dobrą wiadomością jest to, że siatki Lazarusa są wystarczająco elastyczne, aby uzyskać coś z obu światów; programiści mogą łatwo sprawić, by siatki wyglądały podobnie do innych natywnych kontrolek, lub mogą dostosować siatkę w najdrobniejszych szczegółach, aby uzyskać prawie taki sam wygląd na dowolnej platformie lub interfejsie widżetów (tzn. z wyjątkiem pasków przewijania, ponieważ ich wygląd jest wciąż zdeterminowany aktualnym motywem).

Właściwości i Zdarzenia dostosowujące siatek

Niektóre właściwości mogą wpływać na wygląd siatki, działając, gdy komórka ma zostać pomalowana w zdarzeniu PrepareCanvas/OnPrepareCanvas, zmieniając domyślne właściwości płótna (canvas), takie jak kolor pędzla lub czcionka. Poniżej znajduje się lista takich właściwości:

Inne właściwości, które również wpływają na wygląd siatek.

Options.

Właściwość Options to zestaw zawierający kilka elementów umożliwiających różnorodną funkcjonalność, ale niektóre są bezpośrednio związane z wyglądem siatki. Te opcje można ustawić w czasie projektowania lub w czasie wykonywania.

(dopisz więcej)

Opis procesu rysowania siatki

Podobnie jak inne niestandardowe kontrolki, siatka jest rysowana metodą malowania. Ogólnie rzecz biorąc, siatkę rysuje się malując wszystkie wiersze, a każdy wiersz malując poszczególne komórki.

Proces ten wygląda następująco:

Różnice w porównaniu z Delphi

Wybór komórki w siatce

Lokalizację bieżącej (skupionej (focused)) komórki (lub wiersza) siatki można zmienić za pomocą klawiatury, myszy lub kodu. Aby skutecznie zmienić skupienie z jednej komórki na inną, musimy przetestować pozycję docelową, aby sprawdzić, czy może ona otrzymać skupienie na komórce. W przypadku korzystania z klawiatury właściwość część procesu wykonuje AutoAdvance, znajdując następną komórkę, na której ma wykonać skupienie. Podczas korzystania z kliknięć myszą lub poruszania się po kodzie, skupienie nie zostanie przeniesione z bieżącej komórki, chyba że komórka docelowa może takie skupienie otrzymać.

Siatka wywołuje funkcję SelectCell, aby sprawdzić, czy na komórce można wykonać skupienie: jeśli ta funkcja zwraca wartość True, to znaczy, że na komórce docelowej, zidentyfikowanej za pomocą argumentów aCol i aRow jest możliwe wykonanie skupienia (bieżąca implementacja TCustomGrid po prostu zwraca True). TCustomDrawGrid, a zatem także TDrawGrid i TStringGrid przesłaniają tę metodę, aby najpierw sprawdzić, czy komórka jest szersza niż 0; normalnie nie chcesz, aby wybrana została komórka o szerokości 0, więc komórka z tymi cechami jest automatycznie pomijana w procesie wyszukiwania odpowiedniej komórki. Inną rzeczą, jaką robi zastąpiona metoda SelectCell, jest wywołanie konfigurowanego przez użytkownika zdarzenia OnSelectCell: to zdarzenie odbiera współrzędne komórki jako argumenty i zawsze zwraca w wyniku domyślną wartość True.

Gdy wiadomo, że komórka może uzyskać skupienie i jesteśmy pewni, że nastąpi ruch, najpierw wywoływana jest metoda BeforeMoveSelection; to z kolei wyzwala zdarzenie OnBeforeSelection. Argumentami tej metody są współrzędne nowej komórki ze skupieniem. W tym momencie każdy widoczny edytor jest również ukryty. Słowo „before” (przed) oznacza, że ​​zaznaczenie nie zostało jeszcze zmienione, a dostęp do aktualnych współrzędnych komórki skupionej można uzyskać za pomocą właściwości grid.Col i grid.Row.

Następnie wewnętrzne współrzędne skupionej komórki są zmieniane, a potem wywoływana jest metoda MoveSelection; celem tej metody jest wyzwolenie zdarzenia OnSelection, jeśli jest ustawione (jest to powiadomienie, że skupiona komórka już się zmieniła, a współrzędne komórki są teraz dostępne we właściwościach grid.row i grid.col).

Należy zauważyć, że nie jest dobrze używać zdarzenia OnSelectCell do wykrywania zmian skupienia komórki, ponieważ to zdarzenie zostanie wyzwolone kilka razy nawet dla tej samej komórki w procesie wyszukiwania odpowiedniej komórki. Lepiej jest użyć do tego celu zdarzeń OnBeforeSelection lub OnSelection.

Różnice w porównaniu z Delphi

Gdy powyższe dostosowanie nie wystarczy, siatki pochodne

Siatki pochodne zazwyczaj muszą zastąpić następujące metody:
DrawAllRows: Rysuje wszystkie widoczne wiersze.
DrawRow: Rysuje wszystkie komórki w rzędzie.
DrawRow rysuje wszystkie komórki w rzędzie, najpierw sprawdzając, czy komórka znajduje się w obszarze przycinania, i rysuje tylko komórkę, jeśli tak jest.
DrawCell:
DrawCellGrid:
DrawCellText:
DrawFocusRect:
(napisz do mnie).\

Co dzieje się w metodzie TCustomGrid.Paint?

Poniższa lista pokazuje wewnętrzną kolejność wywołań metod dla malowania TCustomGrid (lub potomka). Każda pozycja na listach reprezentuje wywołania metod podczas operacji malowania. Powinno to pomóc w znalezieniu właściwego punktu do zmiany zachowania, jeśli chodzi o tworzenie klas potomnych z TCustomGrid.

Dodatkowe metody rysowania w TCustomGrid

Te metody są zadeklarowane i (częściowo) zaimplementowane w TCustomGrid, ale nie są wywoływane bezpośrednio z tego miejsca. Są używane przez klasy potomne do rysowania zawartości komórki.

Metody rysowania wprowadzone przez TCustomDrawGrid

Jak widać, klasa bazowa TCustomGrid nie rysuje żadnej zawartości w komórkach. Odbywa się to w TCustomDrawGrid. TCustomDrawGrid nadpisuje metodę DrawCell w następujący sposób:

Zapisz i Odzyskaj zawartość siatki

Metody SaveToFile i LoadFromFile umożliwiają siatce zapisywanie i pobieranie układu i danych do/z pliku w formacie XML. TStringGrid, odziedziczony z TCustomStringGrid, ma również możliwość „eksportowania” i „importowania” swojej zawartości do/z pliku w formacie wartości oddzielonych przecinkami, lepiej znanego jako format pliku CSV. Jest to opisane w dokumentacji do metod SaveToCSVFile i LoadFromCSVFile (do zrobienia: utworzyć łącza).

Rodzaj informacji, które można zapisać, a następnie pobrać podczas używania SaveToFile i LoadFromFile, jest określony przez właściwość SaveOptions (typu TSaveOptions), która jest zestawem opcji opisanych w następujący sposób:

pascal
soDesign:     Zapisz i wczytaj ColCount,RowCount,FixedCols,FixedRows,
              ColWidths, RowHeights i Options (TCustomGrid)
soPosition:   Zapisz i wczytaj warto??ci pozycji Scroll, Row, Col i Selection (TCustomGrid)
soAttributes: Zapisz i wczytaj kolory, wyr??wnanie tekstu i uk??ad itp. (TCustomDrawGrid)
soContent:    Zapisz i wczytaj tekst (TCustomStringGrid)
soAll:        Ustaw wszystkie opcje (soAll:=[soDesign,soPosition,soAttributes,soContent];)

Nie wszystkie opcje mają zastosowanie do wszystkich rodzajów siatek, na przykład soContent nie mają zastosowania do siatek pochodnych TCustomGrid, takich jak TDrawGrid, ponieważ ten rodzaj siatki nie zawiera pojęcia „treści”. TStringGrid jest specjalnym rodzajem siatki, która „wie”, jak obsługiwać łańcuchy i może użyć opcji soContent, jeśli jest określona.

Opcja soAttributes nie jest używana w standardowych siatkach Lazarusa, jest dostępna w przypadku siatek potomnych.

Podczas używania LoadFromFile siatka używa również właściwości SaveOptions, aby wiedzieć, jakie informacje należy pobrać z pliku, więc np. jest całkowicie możliwe określenie SaveOptions:=[soDesign,soContent] przy zapisywaniu i tylko SaveOptions :=[soContent] podczas ładowania.

Dla TStringGrid domyślną wartością SaveOptions jest [soContent], dla innego rodzaju siatek SaveOptions jest pustym zbiorem.

Uwaga: Jeden typowy problem podczas zapisywania i pobierania danych siatki występuje, gdy użytkownik określi właściwość SaveOptions przed SaveToFile, ale nie przed LoadFromFile. W przypadku użycia LoadFromFile jakiś czas po użyciu SaveToFile właściwość SaveOptions jest ustawiona prawidłowo, ale jeśli LoadFromFile zostanie wykonane przy następnym uruchomieniu programu, właściwość SaveOptions może nie zostać poprawnie skonfigurowane, z tego powodu zaleca się, aby zawsze określać właściwość SaveOptions tuż przed LoadFromFile lub robić to globalnie podczas uruchamiania programu, jak w poniższym przykładzie:

Przykład:

  1. Najpierw przejdź do menu "Plik -> Nowy -> Aplikacja";
  2. Umieść pusty TStringGrid w formularzu;
  3. Umieść na formularzu TButton i TOpenDialog;
  4. Dodaj zdarzenie OnCreate do formularza;
  5. Dodaj zdarzenie OnClick dla przycisku.
pascal
unit Unit1; 

{$mode objfpc}{$H+}

interface

uses
  Classes, SysUtils, LResources, Forms, Controls, Graphics, Dialogs, Grids,
  Buttons, StdCtrls, XMLCfg;

type

  { TForm1 }
  TForm1 = class(TForm)
    StringGrid1: TStringGrid;
    Button1: TButton;
    OpenDialog1: TOpenDialog;
    procedure Button1Click(Sender: TObject);
    procedure Form1Create(Sender: TObject);
  private
    { private declarations }
  public
    { public declarations }
  end; 

var
  Form1: TForm1; 

implementation

{ TForm1 }

procedure TForm1.Form1Create(Sender: TObject);
begin
 //ustawia SaveOptions w momencie tworzenia formularza
 stringgrid1.SaveOptions := [soDesign,soPosition,soAttributes,soContent];
end;

procedure TForm1.Button1Click(Sender: TObject);
begin
 //Pytaj, czy uruchomiono metodę Execute w OpenDialog,
 //a gdy to nastąpi, użytkownik wybiera plik XML do załadowania,
 //którego nazwa była przechowywana we właściwości FileName.

 if opendialog1.Execute then
 begin
   //Wyczyść siatkę
   StringGrid1.Clear;
   //Załaduj plik XML
   StringGrid1.LoadFromFile(OpenDialog1.FileName);
   //Odśwież siatkę
   StringGrid1.Refresh;
 end;
end;

initialization
  {$I unit1.lrs}

end.

Przykładowy plik xml: (Skopiuj poniższy tekst do pliku txt. Nie zapomnij umieścić nagłówka xml :-))

xml
<?xml version="1.0"?>
<CONFIG>
  <grid version="3">
    <saveoptions create="True" position="True" content="True"/>
    <design columncount="2" rowcount="5" fixedcols="1" fixedrows="1" defaultcolwidth="64" defaultRowHeight="20">
      <options>
        <goFixedVertLine value="True"/>
        <goFixedHorzLine value="True"/>
        <goVertLine value="True"/>
        <goHorzLine value="True"/>
        <goRangeSelect value="True"/>
        <goDrawFocusSelected value="False"/>
        <goRowSizing value="False"/>
        <goColSizing value="False"/>
        <goRowMoving value="False"/>
        <goColMoving value="False"/>
        <goEditing value="False"/>
        <goTabs value="False"/>
        <goRowSelect value="False"/>
        <goAlwaysShowEditor value="False"/>
        <goThumbTracking value="False"/>
        <goColSpanning value="False"/>
        <goRelaxedRowSelect value="False"/>
        <goDblClickAutoSize value="False"/>
        <goSmoothScroll value="True"/>
      </options>
    </design>
    <position topleftcol="1" topleftrow="1" col="1" row="1">
      <selection left="1" top="1" right="1" bottom="1"/>
    </position>
    <content>
      <cells cellcount="10">
        <cell1 column="0" row="0" text="Title Col1"/>
        <cell2 column="0" row="1" text="value(1.1)"/>
        <cell3 column="0" row="2" text="value(2.1)"/>
        <cell4 column="0" row="3" text="value(3.1)"/>
        <cell5 column="0" row="4" text="value(4.1)"/>
        <cell6 column="1" row="0" text="Title Col2"/>
        <cell7 column="1" row="1" text="value(1.2)"/>
        <cell8 column="1" row="2" text="value(2.2)"/>
        <cell9 column="1" row="3" text="value(3.2)"/>
        <cell10 column="1" row="4" text="value(4.2)"/>
      </cells>
    </content>
  </grid>
</CONFIG>

Edytory komórek siatki

Siatka używa edytorów komórek do zmiany zawartości komórek.

W przypadku wyspecjalizowanej siatki, takiej jak TStringGrid, edytor jest zwykłą jednowierszową kontrolką edytora tekstu, ale czasami pożądane jest posiadanie innych sposobów wprowadzania informacji. Na przykład:

  1. pokaż okno dialogowe otwierania pliku, po to by znaleźć lokalizację pliku, żeby użytkownik nie musiał ręcznie wpisywać pełnej ścieżki
  2. jeśli tekst w komórce reprezentuje datę, wyświetl kalendarz, abyśmy mogli łatwo wybrać konkretną datę.

Czasami informacje, które użytkownik powinien wprowadzić w komórce, są ograniczone do ograniczonej listy słów; w takim przypadku bezpośrednie wpisywanie informacji może wprowadzać błędy i może zaistnieć potrzeba zaimplementowania procedur sprawdzania poprawności. Możemy tego uniknąć, używając edytora komórek, który przedstawia użytkownikowi listę zawierającą tylko prawidłowe wartości.

Dotyczy to również ogólnych siatek, takich jak TDrawGrid, w których użytkownik potrzebuje jakiejś struktury do przechowywania danych, które będą wyświetlane w siatce. W takiej sytuacji informacje wprowadzone w edytorze komórek aktualizują wewnętrzną strukturę, aby odzwierciedlić zmiany w siatce.

Wbudowane edytory komórek

Moduł grids.pas zawiera już niektóre z najczęściej używanych edytorów komórek gotowych do użycia w siatkach. Możliwe jest również tworzenie nowych edytorów komórek (niestandardowe edytory komórek), jeśli wbudowane edytory nie są odpowiednie do określonego zadania.

Wbudowane edytory komórek to Button, Edit i Picklist.

Korzystanie z edytorów komórek

Użytkownicy mogą określić, jaki edytor będzie używany dla danej komórki, korzystając z jednej z dwóch metod.

  1. Korzystanie z niestandardowej kolumny i wybranie właściwości ButtonStyle kolumny. W pierwszej metodzie użytkownik może wybrać styl edytora, który będzie wyświetlany. Dostępne wartości to: cbsAuto, cbsEllipsis, cbsNone, cbsPickList, cbsCheckboxColumn, cbsButtonColumn.
  2. Używanie zdarzenia siatki OnSelectEditor. W drugiej metodzie, w parametrze Editor użytkownik określa, którego edytora użyć dla komórki zidentyfikowanej dla kolumny aCol i wiersza ARow w siatce pochodnej TCustomDrawGrid lub TColumn w TCustomDBGrid. Do tego celu służy publiczna funkcja siatek EditorByStyle(), która jako parametr przyjmuje jedną z następujących wartości: cbsAuto, cbsEllipsis, cbsNone, cbsPickList, cbsCheckboxColumn, cbsButtonColumn. Ta metoda ma pierwszeństwo przed metodą pierwszą, gdy używane są kolumny niestandardowe. W tym miejscu można określić niestandardowy edytor komórek (patrz rozdział 5 tego dokumentu autorstwa Michaëla Van Canneyta, który wyjaśnia jak poprawnie zaimplementować niestandardowy edytor). To zdarzenie jest również miejscem do zamontowania edytora z wartościami specyficznymi dla komórki, wiersza lub kolumny (np. niestandardowe menu kontekstowe dla edytora komórek).

Ustawienie właściwości ButtonStyle działa tylko wtedy, gdy kolumna jest tworzona za pomocą polecenia StringGrid1.Columns.Add;. Użycie wyrażenia takiego jak StringGrid1.ColCount:=X; spowoduje wyjątek. Ustawienie właściwości ButtonStyle można wykonać za pomocą podobnego kodu:

pascal
if ColCB< StringGrid1.Columns.Count
   then StringGrid1.Columns.Items[ColCB].ButtonStyle:=cbsCheckboxColumn;

Opis stylów edytora

Poniżej znajduje się opis stylów edytora. Są to wartości wyliczeniowe typu TColumnButtonStyle, dlatego są poprzedzone przedrostkiem „cbs”. Ten typ został użyty, aby zachować kompatybilność z DBGrid firmy Delphi.

To jest domyślny styl edytora dla siatek potomnych TCustomGrid. Rzeczywista klasa edytora, która będzie używana do edycji zawartości komórki, zależy od kilku czynników. W przypadku TCustomGrids używana jest klasa TStringCellEditor pochodząca z TCustomMaskEdit. Ten edytor wyspecjalizowany jest do edycji jednowierszowych ciągów string. Jest on następnie domyślnie używany w TStringGrid i TDrawGrid. W przypadku korzystania z kolumn niestandardowych, jeśli programista wypełnił właściwość PickList kolumny, działa to tak, jakby ustawiono styl edytora cbsPickList. W przypadku TCustomDBGrid, który ma pole typu boolean, zachowuje się on tak, jakby określono styl edytora cbsCheckBoxColumn. Jest to zalecana wartość dla niestandardowych edytorów komórek. Do zrobienia: odniesienie do OnEditingDone.

Ten styl edytora jest najbardziej ogólny. Gdy jest używany, w komórce edycji pojawia się przycisk, a programiści mogą użyć zdarzenia siatki OnEditButtonClick, aby wykryć, kiedy użytkownik nacisnął przycisk i podjąć dowolną akcję zaprogramowaną dla takiej komórki. Na przykład programista może użyć tego stylu edytora, aby wyświetlić okno dialogowe kalendarza, aby umożliwić użytkownikowi łatwe wybranie określonej daty. Innymi możliwościami może być wyświetlenie okna dialogowego otwierania pliku w celu znalezienia plików, kalkulatora, aby użytkownik mógł wprowadzić liczbowy wynik obliczeń itp.

OnEditButtonClick to tylko powiadomienie, aby dowiedzieć się, w której komórce został kliknięty przycisk, sprawdź właściwości grid.Row i grid.Col.

A DBGrid ma specyficzne właściwości do pobierania aktywnej kolumny lub pola, a ponieważ to zdarzenie występuje w aktywnym rekordzie, może aktualizować informacje w aktywnym polu.

Ten styl edytora jest zaimplementowany przy użyciu TButtonCellEditor, bezpośredniego potomka TButton.

Ten styl edytora instruuje siatkę, aby nie używała żadnego edytora dla określonej komórki lub kolumny; zachowuje się wtedy tak, jakby siatka była tylko do odczytu dla takiej komórki lub kolumny.

Służy do przedstawienia użytkownikowi listy wartości, które można wprowadzić. Ten styl edytora jest zaimplementowany przy użyciu TPickListCellEditor, komponentu wywodzącego się z TCustomComboBox. Lista wyświetlanych wartości jest wypełniana na jeden z dwóch sposobów, w zależności od metody użytej do wyboru stylu edytora.

  1. W przypadku używania kolumn niestandardowych programiści mogą wprowadzić listę wartości za pomocą właściwości PickList kolumny. [DLA POCZĄTKUJĄCYCH: TODO: dokładna procedura edycji listy]
  2. W OnSelectEditor programiści pobierają instancję TPickListCellEditor za pomocą funkcji EditorByStyle(cbsPickList). Zobacz tutaj przykład

Wartość w siatce TStringGrid automatycznie odzwierciedla wybraną wartość. W razie potrzeby programista może wykryć moment wybrania wartości, zapisując procedurę obsługi zdarzenia dla zdarzenia OnPickListSelect siatki, dzięki czemu można podjąć dodatkowe kroki (na przykład w celu przetworzenia nowej wartości). TODO: powiązanie z OnEditingDone.

Może to być przydatne, gdy zawartość danych powiązana z kolumną jest ograniczona do pary wartości, na przykład tak-nie, prawda-fałsz, włącz-wyłącz, 1-0 itp. Zamiast zmuszać użytkownika do wpisania wartości dla tego rodzaju danych w StringCellEditor lub aby wybrać jedną wartość z listy, cbsCheckboxColumn służy do modyfikowania danych kolumny za pomocą reprezentacji pola wyboru, którą użytkownik może przełączać za pomocą kliknięcia myszą lub wciskając klawisz spacji (jeśli kolumna zawierająca pole wyboru jest zaznaczona i jeśli StringGrid jest edytowalny).

Pobieranie lub ustawianie wartości pola wyboru w komórce odbywa się w następujący sposób:

pascal
StringGrid1.Cell[x,y]:='Z';

gdzie Z należy zastąpić przez 0 dla niezaznaczonego, 1 dla zaznaczonego i pusty ciąg dla wyszarzonego. Zauważ, że każda wartość (string) inna niż 0 i 1 będzie wyświetlana jako szare pole wyboru.

Jeśli właściwość ButtonStyle kolumny jest ustawiona na cbsAuto, a DBGrid wykryje, że pole powiązane z kolumną jest polem logicznym, wówczas siatka automatycznie użyje tego stylu edytora. Ten automatyczny wybór można wyłączyć lub włączyć za pomocą właściwości OptionsExtra DBGrid; ustawienie elementu dgeCheckboxColumn na wartość False wyłącza tą funkcję.

Wartości używane do rozpoznawania stanów zaznaczonych lub niezaznaczonych są ustawiane we właściwościach kolumny ValueChecked i ValueUnchecked.

W dowolnym momencie wartość pola może mieć od jednego do trzech stanów: Unchecked (niezaznaczone), Checked (zaznaczone) lub Grayed (wyszarzone). Wewnętrznie te stany są identyfikowane przez następujące wartości typu TDBGridCheckBoxState: gcbpUnChecked, gcbpChecked i gcbpGrayed.

Ten styl edytora nie używa prawdziwych komponentów TCheckbox do obsługi interakcji użytkownika: wizualną reprezentację zapewniają trzy wbudowane obrazy bitmapowe, które odpowiadają możliwym stanom pola wyboru. Użyte mapy bitowe można dostosować, pisząc procedurę obsługi zdarzenia DBGrid OnUserCheckboxBitmap; program obsługi tego zdarzenia otrzymuje stan pola wyboru w parametrze CheckedState typu TDBGridCheckboxState oraz parametr mapy bitowej, którego programista może użyć do określenia niestandardowych map bitowych.

Ten styl edytora służy do wyświetlania przycisku w każdej komórce w kolumnie. Podobnie jak w przypadku cbsCheckboxColumn ten edytor nie używa prawdziwych przycisków, wygląd jest określony przez aktualny motyw zestawu widżetów.

Użytkownik wie, jaki konkretny przycisk został naciśnięty, obsługując OnEditButtonClick w siatce i sprawdzając kolumnę i wiersz siatki. Zauważ, że w tym konkretnym przypadku zmienne col i row siatki nie identyfikują aktualnie zaznaczonej komórki, ale komórkę klikniętego przycisku. Po obsłużeniu zdarzenia OnEditButtonClick i jeśli użytkownik nie zmodyfikował col lub row siatki w tej procedurze obsługi, siatka automatycznie resetuje col i row, aby odzwierciedlić aktualnie wybraną komórkę. Podczas obsługi OnEditButtonClick bieżący wybór siatki jest dostępny w grid.Selection, który jest właściwością typu TRect, Left i Right reprezentują indeksy kolumn, Top i Bottom są indeksami wierszy.

Podpis przycisku to odpowiedni ciąg string komórki.

Edycja siatek

Efekt edycji jest różny w zależności od rodzaju użytej siatki, na przykład TStringGrid przechowuje edytowany tekst wewnętrznie, a TDBGrid wpływa na rekordy w zestawie danych (dataset). TDrawGrid nie wie, co zrobić z edytowanym tekstem, jeśli programista nie przejmie nad nim kontroli, jest on po prostu odrzucany.
Dla TDrawGrid (chociaż powinno to działać dla wszystkich klas siatki) w celu uzyskania dostępu do edytowanego tekstu, programista może użyć zdarzenia OnSetEditText, które jest wyzwalane za każdym razem, gdy użytkownik zmodyfikuje coś w edytorze, parametry aCol i aRow tego zdarzenia identyfikują edytowaną komórkę, parametr Value przechowuje tekst, jest to zalecana metoda. Innym sposobem dostępu do edytowanego tekstu jest pobranie go bezpośrednio z edytora po zakończeniu procesu edycji za pomocą zdarzenia OnEditingDone. Można to osiągnąć, uzyskując dostęp do wewnętrznego edytora używanego do edycji, w tym przypadku domyślnego „String Cell Editor” (Komórkowy Edytor String). W tym celu istnieją dwie metody: Pierwsza polega na użyciu zdarzenia OnSelectEditor, gdzie parametr Editor jest instancją, która będzie używana do edycji komórki, musisz zapisać tę instancję do zmiennej, na przykład TheEditor (typu TSringCellEditor), do późniejszego wykorzystania w OnEditingDone. Drugą alternatywą jest użycie metody siatki EditorByStyle, ta metoda akceptuje „styl edytora” jako parametr i zwraca instancję edytora odpowiadającego temu stylowi. W naszym przypadku wiedząc, że styl cbsAuto zwraca domyślny edytor komórek, w module obsługi zdarzenia OnEditingDone możemy bezpośrednio użyć TheEditor := Grid.EditorByStyle(cbsAuto). Następnie możesz pobrać tekst za pomocą TheEditor.Text. Jeśli zastosujesz tę metodę, zauważ, że „z wielką mocą wiąże się wielka odpowiedzialność”.

Opcje i właściwości wpływające na edycję

Zachowanie edycyjne jest kontrolowane przez szereg właściwości i opcji, praktycznie każde dostosowanie lub opcje, które wpływają na edycję, wymagają edytowalnej siatki, w przeciwnym razie takie dostosowanie może zostać zignorowane.
Na początku edytowalny stan siatek jest inny, dla TDrawGrid i TStringGrid edycja jest wyłączona, dla TDbGrid jest domyślnie włączona.
Właściwość Options zawiera kilka pozycji, które zajmują się edycją, są one opisane poniżej:
*goEditing, dgEditing (w DbGrid). Ta opcja zmienia edytowalny stan siatki, można ją zmienić w czasie wykonywania, ponieważ jest zaznaczona, gdy edycja ma się rozpocząć.

Hint dla komórek

„Hint” to właściwość wyświetlająca wskazówkę, krótką notatkę lub podpowiedź dla kontrolki, nad którą umieścimy kursor myszy. Inna nazwa tego elementu to „Tooltip”. Nazwy spotykane w języku polskim to także „dymek” lub „chmurka”.

Oprócz standardowej właściwości Hint dostępnej dla większości kontrolek, potomkowie TCustomGrid mogą wyświetlać specjalny dymek dla komórki, nad którą znajduje się kursor myszy. Ta funkcja jest kontrolowana przez opcje siatki goCellHints i goTruncCellHints (lub dgCellHints i gdTruncCellHints odpowiednio dla DBGrid):

Jeśli siatka ma wartość w swojej standardowej właściwości Hint, wówczas właściwość HintPriority może być użyta do kontrolowania, w jaki sposób wszystkie te dymki mogą zostać połączone w jedno wyskakujące okienko:

Ponadto standardowa właściwość siatki ShowHint musi być ustawiona na wartość True, aby wyświetlać dymki dotyczące komórek.

Grids w praktyce i przykłady

Skupienie komórki

Wykonanie skupienia (focus) dla komórki w TStringGrid jest łatwe. Zwróć uwagę, że liczenie (zwykle w programowaniu) zaczyna się od zera, a nie od 1. Aby zrobić skupienie dla komórki w 10. rzędzie i 9. kolumnie, wykonaj:

pascal
StringGrid1.Row := 9;
StringGrid1.Col := 8;

Przykład: Jak ustawić niestandardowy edytor komórek

Zobacz lazarus/examples/gridexamples/gridcelleditor/gridcelleditor.lpi (począwszy od Lazarusa 1.2)

Przykład: Jak dodać edytor przycisków

pascal
// Warunkowo pokaż edytor przycisków w kolumnie o indeksie 1 lub 2, jeśli
// komórka w kolumnie o indeksie 1 jest pusta

procedure TForm1.StringGrid1SelectEditor(Sender: TObject; aCol, aRow: Integer; 
  var Editor: TWinControl);
begin
  if (aCol = 1) or (aCol = 2) then
    if StringGrid1.Cells[1,aRow] = '' then
    begin
      Editor := StringGrid1.EditorByStyle(cbsEllipsis);
    end;
  end;

// Uruchamianie akcji...
procedure TForm1.StringGrid1EditButtonClick(Sender: TObject);
begin
  if StringGrid1.Col = 1 then ShowMessage('kliknięto edytor kolumny 1');
  if StringGrid1.Col = 2 then ShowMessage('kliknięto edytor kolumny 2');
end;

Przykład: Praca z PickList, jak ustawić ją tylko do odczytu i jak wypełnić w czasie wykonywania

Za pomocą zdarzenia OnSelectEditor w siatce można dostosować zachowanie edytora PickList (patrz styl przycisku cbsPickList). W kolejnym przykładzie edytor listy wyboru w kolumnie 1 został zmodyfikowany tak, że w nieparzystych wierszach użytkownik może wprowadzać wartości przez ręczne wpisanie, w parzystych wierszach wartości są ograniczone do tych zawartych na liście wyboru. Ten przykład pokazuje również, jak wypełnić listę różnymi wartościami w zależności od przetwarzanego wiersza.

pascal
procedure TForm1.gridSelectEditor(Sender: TObject; aCol, aRow: Integer;
  var Editor: TWinControl);
begin
  if aCol=1 then begin
    if (Editor is TCustomComboBox) then
      with Editor as TCustomComboBox do begin
        if (aRow mod 2=0) then
          Style := csDropDown
        else
          Style := csDropDownList;
        case aRow of
          1:
            Items.CommaText := 'ONE,TWO,THREE,FOUR';
          2:
            Items.CommaText := 'A,B,C,D,E';
          3:
            Items.CommaText := 'MX,ES,NL,UK';
          4:
            Items.CommaText := 'RED,GREEN,BLUE,YELLOW';
        end;
      end;
  end;
end;

Wyrównywanie tekstu w StringGrids

Ten kod pokazuje, jak używać różnych sposobów wyrównania tekstu w kolumnach 2 i 3.

pascal
procedure TForm1.StringGrid1PrepareCanvas(sender: TObject; aCol, aRow: Integer;
  aState: TGridDrawState);
var
  MyTextStyle: TTextStyle;
begin
  if (aCol=2) or (aCol=3) then
  begin
    MyTextStyle := StringGrid1.Canvas.TextStyle;
    if aCol=2 then
      MyTextStyle.Alignment := taRightJustify 
    else 
    if aCol=3 then
      MyTextStyle.Alignment := taCenter;
    StringGrid1.Canvas.TextStyle := MyTextStyle;
  end;
end;

Wielowierszowy tekst w siatkach

Ten przykład pokazuje, jak utworzyć tekst wielowierszowy w komórce [3,2]. Działa to tak samo dla DBGrid, gdzie OnPrepareCanvas ma parametry do radzenia sobie z TColumns, a stamtąd z TFields.

pascal
procedure TForm1.StringGrid1PrepareCanvas(sender: TObject; aCol, aRow: Integer;
  aState: TGridDrawState);
var
  MyTextStyle: TTextStyle;
begin
  if (aRow=2) or (aCol=3) then
  begin
    MyTextStyle := StringGrid1.Canvas.TextStyle;
    MyTextStyle.SingleLine := false;
    StringGrid1.Canvas.TextStyle := MyTextStyle;
  end;
end;

Weryfikacja wprowadzonych wartości

Lazarus w wersji 0.9.29 wprowadza w StringGrid zdarzenie OnValidateEntry typu TValidateEntryEvent, które ma następującą deklarację:

pascal
type
  TValidateEntryEvent = procedure(sender: TObject; aCol, aRow: Integer; const OldValue: string; var NewValue: string) of object;
text
aCol, aRow to współrzędne sprawdzanej komórki.
OldValue to wartość, która znajdowała się w komórce cells[aCol, aRow] przed rozpoczęciem edycji.
NewValue to wartość, która zostanie ostatecznie wstawiona do komórki cells[aCol, aRow].

Ze względu na sposób, w jaki działa StringGrid, ustawiając wartość komórki podczas edycji przez użytkownika (patrz zdarzenie OnSetEditText w siatce i metoda SetEditText), gdy wyzwalane jest zdarzenie OnValidateEntry, komórka zawiera już wprowadzoną wartość (prawidłową lub nie); za pomocą argumentów zdarzenia OldValue i NewValue wartość komórki może zostać zweryfikowana i zmieniona w razie potrzeby.

Zwykle sprawdzanie poprawności następuje, gdy użytkownik przeniósł się do innej komórki. Jeśli walidacja się nie powiedzie, pożądane jest, aby edytor komórek był widoczny/aktywny, aby wpisana wartość mogła zostać poprawiona przez użytkownika. Aby siatka wiedziała, że ​​walidacja nie powiodła się, należy zgłosić wyjątek. Siatka obsłuży wyjątek poprzez Application.HandleException i każdy ruch zostanie anulowany.

Na przykład, załóżmy że komórka cell[1,1] powinna zawierać tylko wartości 'A' lub 'B', walidację można przeprowadzić za pomocą:

pascal
procedure TForm1.GridValidateEntry(sender: TObject; aCol,
  aRow: Integer; const OldValue: string; var NewValue: String);
begin
  if (aCol=1) and (aRow=1) then begin
    if grid.Cells[aCol,aRow]<>'A') and grid.Cells[aCol,aRow]<>'B') then begin
      // ustaw nową prawidłową wartość, aby użytkownik mógł na przykład nacisnąć RETURN, aby kontynuować.
      NewValue := 'A';
      // inną opcją jest powrót do poprzedniej wartości komórki (która z założenia jest prawidłowa)
      // NewValue := OldValue;
      // Użyj EAbort zamiast innego przerwania typu Exception, aby uniknąć okna dialogowego
      // z fałszywym komunikatem błędu i odwrotnego debugowania
      raise EAbort.Create('Tylko A lub B są tutaj dozwolone');
    end else begin
      // jeśli nie zostanie zgłoszony żaden wyjątek, przyjmuje się, że wartość jest prawidłowa, ale
      // w razie potrzeby ostateczną wartość można jeszcze zmienić, wypełniając NewValue inną wartością

      // komputer wie lepiej :)
      if grid.Cells[1,1]='A' then 
        NewValue := 'B' 
      else 
        NewValue := 'A';
    end;
  end;
end;

Sortowanie kolumn lub wierszy

Właściwość ColumnClickSorts umożliwia automatyczne sortowanie siatki wtedy, gdy użytkownik kliknie nagłówek kolumny. Wielokrotne kliknięcie tej samej kolumny zmienia kolejność sortowania. Wyświetlane są obrazy domyślnego sortowania kolumn, które wskazują, która kolumna została kliknięta.

W kodzie możesz użyć metody SortColRow().

Pierwszy parametr, IsColumn, to wartość logiczna. Ustaw ją na:

Drugi parametr, index, jest liczbą całkowitą:

Ostatnie dwa parametry są opcjonalne, określają podzakres wierszy lub kolumn do sortowania.

Jeśli ostatnie dwa parametry nie zostaną określone, sortowana jest cała kolumna lub wiersz.

Sortowanie wykorzystuje algorytm QuickSort, można go zmienić, jeśli siatka potomna przesłoni metodę sort() i wywoła funkcję doCompareCells w celu porównania komórek.

Domyślnie zawartość komórek sortowana jest jako ciągi string w kolejności rosnącej lub malejącej. Kolejność można wybrać za pomocą właściwości SortOrder. Domyślnie używana jest kolejność rosnąca.

pascal
// Sortuj kolumnę 3 w kolejności rosnącej
grid.SortColRow(true, 3);

// Sortuj kolumnę 3 w kolejności malejącej, pomiń wiersze stałe (fixed) u góry
grid.SortOrder := soDescending; // lub soAscending
grid.SortColRow(true, 3, grid.FixedRows, grid.RowCount-1);

Do niestandardowego sortowania liczb, dat, stanów itp. StringGrid ma zdarzenie OnCompareCells, które użytkownicy mogą wykorzystać na przykład w ten sposób:

pascal
procedure TForm1.GridCompareCells(Sender: TObject; ACol, ARow, BCol, BRow: Integer; var Result: integer);
begin
  // Wynik będzie <0, =0 lub >0 dla normalnego sortowania.
  result := StrToIntDef(Grid.Cells[ACol,ARow],0)-StrToIntDef(Grid.Cells[BCol,BRow],0);
  //W przypadku odwrotnej kolejności, wystarczy zanegować wynik (np. bazując na SortOrder siatki).
  if StringGrid1.SortOrder = soDescending then
    result := -result;
end;

Możesz użyć OnCompareCells również wtedy, gdy automatyczne sortowanie kolumn jest włączone za pomocą właściwości ColumnClickSorts.

Zastąp sortowanie automatyczne (ColumnClickSorts ustawione na False ). Unikaj niektórych kolumn. Pokaż strzałki sortowania w nagłówku kolumny

(gdy ColumnClickSorts jest ustawione na False, to w nagłówku kolumny NIE są wyświetlane strzałki sortowania, a więc musimy ustawić strzałki.)

pascal
procedure TForm1.StringGrid1HeaderClick(Sender: TObject; IsColumn: Boolean;
 Index: Integer);
begin
 if isColumn then with StringGrid1 do
  begin
    col:=Index;                                                  // Wybierz kolumnę do sortowania
    if Tag  = 0 then Tag :=-1                                    // Załóżmy, że dane w kolumnie są posortowane rosnąco
                else Tag := Tag  * -1;                           // Używanie StringGrid1.Tag do przechowywania porządku sortowania
                                                                 // Pierwsze kliknięcie nagłówka posortuje kolumnę malejąco

     // Aktywuj CompareCells (aktywuj sortowanie)
    case Index of
      0: col:=-1;                                                // Nie sortuj kolumny 0 i nie pokazuj strzałki sortowania
      1: SortColRow(True, Index);                                // Sortowanie odbędzie się w CompareCells zaraz po wykonaniu instrukcji
      2: SortColRow(True, Index);
      3: SortColRow(True, Index);
      4: SortColRow(True, Index);
      5: col:=-1;                                                // Nie sortuj kolumny 5 i nie pokazuj strzałki sortowania
    end;
  end;
end;

// Compare zwraca jedną z następujących wartości:
// jeśli A<B  zwraca: -1            ( Rosnąco )
// jeśli A=B  zwraca:  0
// jeśli A>B  zwraca:  1            ( Malejąco)

// Jak sortować: Text, Integer, Float, DateTime:

procedure TForm1.StringGrid1CompareCells(Sender: TObject; ACol, ARow, BCol,
 BRow: Integer; var Result: integer);

  function CompareTextAsText: Integer;                         // Text
  begin
    CompareText(Cells[ACol,ARow], Cells[BCol,BRow]);
  end;

  function CompareTextAsInteger: Integer;
  var i1,i2:Integer;
  begin
    if TryStrToInt(StringGrid1.Cells[ACol,ARow],i1) and       // Integer
       TryStrToInt(StringGrid1.Cells[BCol,BRow],i2) then
    Result := CompareValue(i1, i2)
    else Exit(0);
  end;  

  function CompareTextAsFloat: Integer;                        // Float
  var f1,f2:Extended;
  begin
    if TryStrToFloat(StringGrid1.Cells[ACol,ARow],f1) and
       TryStrToFloat(StringGrid1.Cells[BCol,BRow],f2) then
    Result := CompareValue(f1, f2)
    else Exit(0);
  end;

  function CompareTextAsDateTime: Integer;                  // DateTime
  var
  D1, D2 : TDateTime;
  begin
    if Trim(StringGrid1.Cells[ACol,ARow]) <> Trim(StringGrid1.Cells[BCol,BRow]) then
    begin
      if trim(StringGrid1.Cells[ACol,ARow]) = '' then Exit(1);
      if Trim(StringGrid1.Cells[BCol,BRow]) = '' then Exit(-1);
    end
    else Exit(0);

    if TryStrToDate(StringGrid1.Cells[ACol,ARow], D1, 'yy/mm/dd') and
       TryStrToDate(StringGrid1.Cells[BCol,BRow], D2, 'yy/mm/dd') then
    Result := CompareDateTime(D1, D2)
    else Exit(0);
 end;

begin                                        // Nie rób tutaj nic więcej, sortowanie może być zrobione niepoprawnie
  With    StringGrid1 do
  begin
    case ACol of
      0 : ;                                                                     // Nie sortuj kolumny 0
      1 :  Result := CompareTextAsText;                                         // Text
      2 :  Result := CompareTextAsInteger;                                      // Integer
      3 :  Result := CompareTextAsFloat;                                        // Float
      4 :  Result := CompareTextAsDateTime;                                     // DateTime
    end; {Case}
  end;
  if  StringGrid1.Tag  = -1 then   Result := -Result;                           // Zmień kolejność sortowania
end;  

// DrawCell załatwia sprawę, poprzednie obrazy strzałek są usuwane: 
procedure TForm1.StringGrid1DrawCell(Sender: TObject; aCol, aRow: Integer;
  aRect: TRect; aState: TGridDrawState);
   
   procedure DrawArrow(ImgIndex:Integer);                  // Potrzebujesz obrazów strzałek w górę/w dół w ImageList
   begin
     with StringGrid1 do
       TitleImageList.Draw(Canvas,                         // TitleImageList z StringGrid
       ARect.Right - TitleImageList.Width,
      (ARect.Bottom - ARect.Top - TitleImageList.Height) div 2 + 2,  // Położenie strzałki można regulować.
       ImgIndex );
   end;
begin
  if Col > 0 then                                    // W tym demo nie ma strzałek w kolumnie 0
    if (ARow = 0) and                                // Załóżmy, że wiersz 0 jest wierszem tytułu
       Assigned(TitleImageList) then                 // Potrzebujesz strzałek w górę/w dół w ImageList
         case Columns.Items[aCol].Tag of             // Użyj właściwości Tag kolumny jako indeksu strzałki rosnąco/malejąco
           -1: DrawArrow(1);                         // Zastąp swoim indeksem strzałki w dół
            0: DrawArrow(-1);                        // Usuń poprzedni obraz
            1: DrawArrow(2);                         // Zastąp swoim indeksem strzałki w górę
         end;
end;

Podświetlenie wybranych komórek kolumny i wiersza

W rewizji 40276 Lazarusa dodano opcję (gdRowHighlight), która działa podobnie do goRowSelect, ale używa jaśniejszego koloru do zaznaczania, a prostokąt skupienia wskazuje zaznaczoną komórką, a nie cały rząd. Działa to dobrze w przypadku wierszy, ale co z kolumnami?.

Ta sekcja przedstawia sposób podświetlania kolumn, wierszy lub obu (przykład podświetlający tylko nagłówki kolumn i wierszy można znaleźć w lazarus/examples/gridexamples/spreadsheet, ten praktyczny poradnik jest tak naprawdę rozszerzeniem tego przykładu). Wykorzystywane są dwa zdarzenia siatki: OnBeforeSelection i OnPrepareCanvas, a rysowanie nie jest konieczne.

Zdarzenie OnBeforeSelection jest wyzwalane, gdy zaznaczenie ma ulec zmianie. W tym zdarzeniu możemy się dowiedzieć, która komórka jest aktualnie zaznaczona i jaka komórka zostanie wybrana jako następna. Używamy tych informacji, aby unieważnić cały wiersz lub kolumnę zarówno dla starych, jak i nowych komórek. Gdy rozpocznie się następny cykl malowania, siatka zostanie poinstruowana, aby pomalować komórki należące do obszarów unieważnionych. Jednym z pierwszych kroków podczas malowania jest wywołanie zdarzenia OnPrepareCanvas (jeśli istnieje) w celu ustawienia domyślnych właściwości płótna. Używamy tego zdarzenia do ustawienia podświetlonego wiersza lub kolumny:

pascal
procedure TForm1.gridBeforeSelection(Sender: TObject; aCol, aRow: Integer);
begin
  // tutaj możemy zdecydować, czy chcemy podświetlać kolumny, wiersze, czy jedno i drugie
  // w tym przykładzie podświetlamy oba

  if Grid.Col<>aCol then
  begin
    // wykryto zmianę w bieżącej kolumnie
    grid.InvalidateCol(aCol);      // unieważnia nową wybraną kolumnę komórek
    grid.InvalidateCol(grid.Col);  // unieważnia bieżącą (będzie to „stara”) wybrana kolumna
  end;
  if Grid.Row<>aRow then
  begin
    grid.InvalidateRow(aRow);      // unieważnia nowy wybrany wiersz komórki
    grid.InvalidateRow(grid.Row);  // unieważnia bieżący (będzie to „stary”) wybrany wiersz
  end;
end; 

procedure TForm1.gridPrepareCanvas(sender: TObject; aCol, aRow: Integer;
  aState: TGridDrawState);
begin
  if gdFixed in aState then
  begin
    if (aCol=grid.Col) or (aRow=grid.Row) then
      grid.Canvas.Brush.Color := clInactiveCaption; // podświetliłoby to również nagłówki kolumn lub wierszy
  end else
  if gdFocused in aState then begin
    // zostawiamy w spokoju aktualnie wybraną/skupioną komórkę
  end else
  if (aCol=Grid.Col) or (aRow=grid.Row) then
    grid.Canvas.Brush.Color := clSkyBlue; // podświetl wiersze i kolumny kolorem clSkyBlue
end;

Unikanie pustego miejsca po prawej stronie ostatniej kolumny

Aby to osiągnąć, siatka musi być w trybie kolumnowym. Gdy właściwość siatki AutoFillColumns ma wartość True, puste miejsce jest dzielone przez wszystkie kolumny, które mają niezerowy SizePriority. Dlatego powinieneś wykonać następujące kroki, aby wypełnić całą poziomą przestrzeń siatki:

Jak przewijać siatkę w czasie rzeczywistym (przesuwanie paska przewijania za pomocą myszy)

If you scroll a Grid by moving the scrollbar with the mouse then the Grid per default is not moved "in realtime". Only after you release the mouse, the Grid "jumps" to its new position. You can enable a scrolling in "realtime" by adding Option goThumbTracking.

Example:

pascal
 StringGrid1.Options:=StringGrid1.Options + [goThumbTracking];

Unfortunately this Option is neither documented in <lazarus-installdir>\lcl\grids.pas (ver 2.0.6) nor in https://lazarus-ccr.sourceforge.io/docs/lcl/grids/tgridoptions.html

Jeśli przewijasz siatkę, przesuwając pasek przewijania za pomocą myszy, domyślnie siatka nie jest przesuwana „w czasie rzeczywistym”. Dopiero po zwolnieniu myszy siatka „przeskakuje” do nowej pozycji. Możesz włączyć przewijanie w czasie rzeczywistym, dodając opcję goThumbTracking.

Przykład:

pascal
 StringGrid1.Options:=StringGrid1.Options + [goThumbTracking];

Niestety ta opcja nie jest udokumentowana w <lazarus-installdir>\lcl\grids.pas (wersja 2.0.6) ani w https://lazarus-ccr.sourceforge.io/docs/lcl/grids/tgridoptions.html

Jak zmienić rozmiar wiersza na podstawie zawartości komórek?

Lacak w raporcie o błędzie #38473 przedstawił następujący kod:

pascal
 
{ TStringGridHelper }
  TStringGridHelper = class helper for TStringGrid
    protected
      procedure AutoSizeRow(aRow: integer);
  end;

{ TStringGridHelper }
procedure TStringGridHelper.AutoSizeRow(aRow: integer);
var
  aCanvas: TCanvas;
  aCol, maxRowHeight:integer;
  aText: String;
  textRect: TRect;
begin
  aCanvas := GetWorkingCanvas(Canvas);
  maxRowHeight := DefaultRowHeight;
  for aCol:=0 to ColCount-1 do begin
    aText := Cells[aCol,aRow];
    textRect := Rect(0, 0, ColWidths[aCol], MaxInt);
    DrawText(aCanvas.Handle, PChar(aText), Length(aText), textRect, DT_CALCRECT or DT_WORDBREAK);
    if maxRowHeight < textRect.Height then
      maxRowHeight := textRect.Height
  end;
  if aCanvas<>Canvas then FreeWorkingCanvas(aCanvas);
  RowHeights[aRow] := maxRowHeight+2;
end;

Dodaj to gdzieś w swoim kodzie źródłowym, a następnie możesz zmieniać rozmiar wiersza tak, jakby procedura AutoSizeRow była częścią siatki, na przykład:

pascal
// Zmień rozmiar wiersza o indeksie 2
grid.AutoSizeRow(2);

DBGrids w praktyce i przykłady

Przykład: Jak ustawić edytor memo dla dbgrids

Możesz oczywiście użyć innej kontrolki zamiast TMemo. Dostosuj według gustu. Zaadaptowane z 1 (uproszczone użycie właściwości SelectedFieldRect, zobacz 2)

pascal
  if (Column.DesignIndex = 3) then
  begin
      GridCellMemo.BoundsRect := DbGrid.SelectedFieldRect;
      GridCellMemo.Text:=Column.Field.AsString;
      Editor := GridCellMemo;
  end;

(Pierwotny post na forum wykorzystywał zdarzenie OnChange, które uruchamia się za każdym razem, gdy zawartość jest zmieniana. Użycie OnEditingDone jest uruchamiane dopiero po zakończeniu edycji przez użytkownika.)

pascal
  if not(Datasource1.State in [dsEdit, dsInsert]) then
    Datasource1.Edit;
    
  Datasource1.DataSet.FieldByName(ResultsGrid.SelectedField.FieldName).AsString:=GridCellMemo.Text;

Uwaga' Używanie normalnej kontrolki jako niestandardowego edytora ma wiele wad: nie zmieni rozmiaru ani nie zmieni położenia podczas zmiany rozmiaru kolumn lub przewijania siatki, musisz zadbać o modyfikację danych w siatce (jak wyjaśniono powyżej), nie działa poprawnie z DbGrids i zakłóca normalną nawigację po siatce za pomocą klawiatury. Siatka współdziała z edytorem za pomocą specjalnych komunikatów siatki, więc lepiej jest utworzyć podklasę kontrolki w celu zarządzania tymi komunikatami, jak wyjaśniono w rozdziale piątym tego dokumentu.

Uwaga Jeśli masz więcej niż jedną siatkę na tej samej formie, użyj innego niestandardowego edytora dla każdej z nich: jeśli użyjesz tego samego elementu sterującego, wydarzą się złe rzeczy, ponieważ obie siatki będą próbowały użyć go jednocześnie.

Przykład: Unikaj wyświetlania pól tekstowych jako „(Memo)” dla DBGrids

When you use SQL statements like "Select * from A" you might see "(Memo)" instead of your content in a grid cell. There are many ways to fix this, but maybe the easiest is to change your statement "Select * from A" to "Select Cast(Column as TEXT) as Column from A". This is a common problem when you use a DBGrid component.

Gdy używasz instrukcji SQL, takich jak „Select * From A”, możesz w komórkach siatki zobaczyć tekst „(Memo)” zamiast rzeczywistej zawartości. Jest wiele sposobów, aby to naprawić, ale być może najłatwiej jest zmienić instrukcję „Select * From A” na „Select Cast(Column as TEXT) as Column From A”. Jest to powszechny problem, gdy używasz komponentu DBGrid.

pascal
 var
    sql : UTF8String;
    Queryu : TSQLQuery;
.....
    sql := 'SELECT cast(Name as TEXT) as Name FROM Client';
    Queryu.SQL.Text:=sql;

Sortowanie kolumn lub wierszy w DBGrid ze strzałkami sortowania w nagłówku kolumny

To jest przykład, który sortuje DBgrid przy użyciu zdarzenia OnTitleClick oraz TSQLQuery i indeksów. Powinno to również działać w przypadku dowolnego zgodnego zestawu danych, takiego jak TbufDataset. Funkcja używa właściwości Column.Tag do przechowywania stanu sortowania dla każdej klikniętej kolumny, więc gdy wrócisz do już posortowanej kolumny, wybierze odpowiednią strzałkę sortowania do wyświetlenia.

Warunki wstępne:

W tym przykładzie użyty TSQLQuery nazywa się OpenQuery.

Aby ponownie użyć komponentu TSQLQuery z inną instrukcją SQL, indeksy muszą zostać wyczyszczone po sortowaniu, w przeciwnym razie zostanie zgłoszony wyjątek podczas otwierania TSQLQuery z inną instrukcją SQL.

pascal
FLastColumn: TColumn; //przechowuj ostatnią kolumnę siatki, według której sortowaliśmy

procedure TSQLForm.ResultsGridTitleClick(Column: TColumn);
const
  ImageArrowUp=0; //powinien pasować do obrazu na ImageList
  ImageArrowDown=1; //powinien pasować do obrazu na ImageList
var
  ASC_IndexName, DESC_IndexName:string;
  procedure UpdateIndexes;
  begin
    // Upewnij się, że definicje indeksów są aktualne
    OpenQuery.IndexDefs.Updated:=false; {<<<--Ta linia jest krytyczna. IndexDefs.Update nie zostanie
    zaktualizowany, jeśli jest już ustawiony na True, co nastąpi w pierwszej posortowanej kolumnie.}
    Openquery.IndexDefs.Update;
  end;
begin
  ASC_IndexName:='ASC_'+Column.FieldName;
  DESC_IndexName:='DESC_'+Column.FieldName;
  // indeksy nie mogą sortować typów binarnych, takich jak ftMemo, ftBLOB
  if (Column.Field.DataType in [ftBLOB,ftMemo,ftWideMemo]) then
    exit;
  // sprawdź, czy indeks sortowania rosnąco już istnieje dla tej kolumny.
  // jeśli nie, utwórz go
  if OpenQuery.IndexDefs.IndexOf(ASC_IndexName) = -1 then
  begin
    OpenQuery.AddIndex(ASC_IndexName,column.FieldName,[]);
    UpdateIndexes; //ensure index defs are up to date
  end;
  // sprawdź, czy indeks sortowania malejąco już istnieje dla tej kolumny.
  // jeśli nie, utwórz go
  if OpenQuery.IndexDefs.IndexOf(DESC_IndexName) = -1 then
  begin
    OpenQuery.AddIndex(DESC_IndexName,column.FieldName,[ixDescending]);
    UpdateIndexes; //ensure index defs are up to date
  end;

  // Użyj właściwości Tag kolumny, aby przełączyć ASC/DESC
  column.tag := not column.tag;
  if boolean(column.tag) then
  begin
    Column.Title.ImageIndex:=ImageArrowUp;
    Openquery.IndexName:=ASC_IndexName;
  end 
  else
  begin
    Column.Title.ImageIndex:=ImageArrowDown;
    OpenQuery.IndexName:=DESC_IndexName;
  end;
  // Usuń strzałkę sortowania z poprzedniej kolumny, którą posortowaliśmy
  if (FLastColumn <> nil) and (FlastColumn <> Column) then
    FLastColumn.Title.ImageIndex:=-1;
  FLastColumn:=column;
end;

Wybieranie rekordów w DBGrid za pomocą pól wyboru

Celem jest umożliwienie wyboru dowolnych rekordów w dbgrid za pomocą pól wyboru (CheckBox), siatka ma możliwość automatycznego wyświetlania pól wyboru po wykryciu pól logicznych, dla innych typów pól użytkownik może ręcznie wybrać styl przycisku cbsCheckboxColumn dla kolumny. W przypadku tego rodzaju kolumn wystarczy kliknąć pole wyboru, a zawartość pola zostanie odpowiednio zmodyfikowana.

Ale co się stanie, jeśli w naszym zbiorze danych nie będzie takiego dostępnego pola? Czy nie chcemy, aby siatka wchodziła w stan edycji po zaznaczeniu pola wyboru? Dodanie kolumny bez pola z ButtonStyle=cbsCheckboxColumn spowoduje wyświetlenie wszystkich pól wyboru wyszarzone i wyłączone, ponieważ nie ma pola połączonego z tą kolumną, a więc nie ma nic do modyfikacji. Ponieważ chcemy sami obsłużyć stan pola wyboru, musimy przechowywać stan gdzieś dla każdego rekordu. W tym celu możemy użyć klasy TBookmarkList (zdefiniowanej w module dbgrids.pas), gdzie właściwość CurrentRowSelected może poinformować, czy bieżący rekord jest zaznaczony, czy nie. Za pomocą zdarzeń dbgrid OnCellClick i OnUserCheckboxState możemy śledzić stan pola wyboru.

Zauważ, że ta technika wymaga Lazarusa w rewizji r31148 lub nowszego, który implementuje zdarzenie OnUserCheckboxState.

pascal
...
uses ..., dbgrids, stdctrls, ...

type

  { TForm1 }

  TForm1 = class(TForm)
  ...
    procedure DBGrid1CellClick(Column: TColumn);
    procedure DBGrid1UserCheckboxState(sender: TObject; column: TColumn; var AState: TCheckboxState);
    procedure FormCreate(Sender: TObject);
    procedure FormDestroy(Sender: TObject);
  ...
  private
    RecList: TBookmarklist;
  ...
  end;

procedure TForm1.DBGrid1CellClick(Column: TColumn);
begin
  if Column.Index=1 then
    RecList.CurrentRowSelected := not RecList.CurrentRowSelected;
end;

procedure TForm1.FormCreate(Sender: TObject);
begin
  RecList := TBookmarkList.Create(DbGrid1);
end;

procedure TForm1.FormDestroy(Sender: TObject);
begin
  RecList.Free;
end;

procedure TForm1.DBGrid1UserCheckboxState(sender: TObject; column: TColumn; var AState: TCheckboxState);
begin
  if RecList.CurrentRowSelected then
    AState := cbChecked
  else
    AState := cbUnchecked;
end;

Przykład: Jak wyeksportować DBGrid do pliku tekstowego

Istnieje kilka sposobów na utworzenie pliku tekstowego z zawartości DBGrid. Zwykle ludzie powiedzą ci, że zamiast myśleć o DBGrid jako kontenerze danych, należy spojrzeć na niego jak na połączony zestaw danych. Ale co się stanie, gdy reprezentacja tekstowa, którą chcesz uzyskać, musi pasować do wyglądu siatek, widoczności kolumn, szerokości lub kolejności? Jednym z rozwiązań jest użycie pakietu LazReport, który ma składnik przeznaczony specjalnie do tworzenia raportu z DbGrid, raport ten można następnie wyeksportować do kilku innych formatów, w tym do formatu tekstowego. Tutaj przedstawiono inne proste rozwiązanie, które może być również wykorzystane jako podstawa dla innych eksporterów formatów tekstowych, na przykład prostego eksportera html.

pascal
// aGrid: Siatka do wyeksportowania
// lpp: Ilość linii na stronę. Bez nagłówka tekstu
// pageBreak: Czy wstaw podział strony. Niektóre drukarki mogą użyć tego do rozpoczęcia nowej strony
// wymagania: moduł LazUTF8
function GridTextExporter(aGrid: TDbGrid; lpp: Integer; pageBreak:boolean): TStringList;
const
  PX_PER_CHAR = 7;

var
  Ds: TDataset;
  book: TBookMark;
  recCount: Integer;
  line: string;
  column: TColumn;

  function WidthToChar(aWidth: Integer): integer;
  begin
    result := trunc(aWidth/PX_PER_CHAR);
  end;

  procedure AddNext(theText: string; alignment: TAlignment);
  var
    width: Integer;
  begin
    if (line<>'') and (line<>#12) then
      line := line + ' ';

    width := WidthToChar(Column.Width);

    case Alignment of
      taRightJustify: line := line + UTF8PadLeft(theText, width);
      taCenter:       line := line + UTF8PadCenter(theText, width);
      else            line := line + UTF8PadRight(theText, width);
    end;
  end;

  procedure CollectHeader;
  begin
    AddNext(Column.Title.Caption, Column.Title.Alignment);
  end;

  procedure CollectField;
  var
    field: TField;
  begin
    field := Column.Field;

    if (field.DataType=ftMemo) and (dgDisplayMemoText in aGrid.Options) then
      AddNext(field.AsString, Column.Alignment)
    else if Field.DataType<>ftBlob then
      AddNext(field.DisplayText, Column.Alignment)
    else
      AddNext('(blob)', Column.Alignment);
  end;

  procedure LoopColumns(printingRecord: boolean);
  var
    c: TCollectionItem;
  begin
    if (not printingRecord) and pageBreak and (result.count>0) then
      line := #12
    else
      line := '';
    for c in aGrid.Columns do begin
      Column := TColumn(c);
      if Column.Visible and (Column.Width>=PX_PER_CHAR) then begin
        if printingRecord then CollectField
        else                   CollectHeader;
      end;
    end;
    result.add(line);
  end;

begin
  result := TStringList.create;
  Ds := aGrid.DataSource.DataSet;
  Ds.DisableControls;
  book := Ds.GetBookmark;
  try
    Ds.First;
    recCount := 0;
    while not DS.EOF do begin
      if RecCount mod lpp = 0 then
        LoopColumns(false);
      LoopColumns(true);
      inc(recCount);
      Ds.Next;
    end;
  finally
    Ds.GotoBookmark(book);
    Ds.FreeBookmark(book);
    Ds.EnableControls;
  end;
end;

Aby skorzystać z tej funkcji, wystarczy wykonać to:

pascal
var
  L: TStringList;
begin
  L := GridTextExporter(grid, 80, true);
  L.SaveToFile('grid.txt');
  L.Free;
end;

Tłumaczenie

Na język polski przełożył: --Sławomir Załęcki (talk) 17:13, 2 February 2022 (CET)

From the Free Pascal wiki, page "Grids Reference Page/pl", as it stood on 2022-02-02 after a change by Slawek, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's Licensing page. If you have concerns about this material, message the admin.

Wersja 3, ostatnia zmiana: WikiArchive, .