Add - metoda (Model obiektów stosowany w Dodatkach VBA)
Add - metoda

Dodaje obiekt do kolekcji.

Składnia

obiekt.Add(składnik)

Składnia metody Add zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
składnik	Element obowiązkowy. Dla kolekcji LinkedWindows jest to obiekt. Dla kolekcji VBComponents jest to wyliczana stała reprezentująca moduł klasy, formularz lub moduł standardowy.
Element składnik może przyjmować jako wartość jedną z następujących stałych:

Stała	Opis
vbext_ct_ClassModule	Dodaje do kolekcji moduł klasy.
vbext_ct_MSForm	Dodaje do kolekcji formularz.
vbext_ct_StdModule	Dodaje do kolekcji moduł standardowy.
Użycie

W przypadku kolekcji LinkedWindows, metoda Add dodaje okno do kolekcji aktualnie połączonych okien.

Uwaga Użytkownik może dodać okno będące okienkiem w pewnej ramce okien połączonych do innej ramki okien połączonych; okno zostaje po prostu przesunięte z jednego okienka do drugiego. Jeśli ramka okien połączonych, z której przesunięto okno, nie zawiera już żadnych okienek, to zostaje zniszczona.

W przypadku kolekcji VBComponents, metoda Add tworzy nowy składnik standardowy i dodaje go do projektu.

W przypadku kolekcji VBComponents, metoda Add zwraca obiekt VBComponent. W przypadku kolekcji LinkedWindows metoda Add zwraca Nothing.


AddFromFile - metoda (Model obiektów stosowany w Dodatkach VBA)
AddFromFile - metoda

W przypadku kolekcji References, metoda dodaje z pliku wskazanie na projekt. W przypadku obiektu CodeModule, dodaje do modułu zawartość pliku.

Składnia

obiekt.AddFromFile(nazwa_pliku)

Składnia metody AddFromFile zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
nazwa_ pliku	Element obowiązkowy. Wyrażenie znakowe określające nazwę pliku, który ma być dodany do projektu lub modułu. Jeśli nie znaleziono nazwy pliku, a ścieżka nie jest określona, plik będzie poszukiwany w katalogach przeszukiwanych przez funkcję Windows OpenFile.
Użycie

W przypadku obiektu CodeModule, metoda AddFromFile wstawia zawartość pliku począwszy od wiersza poprzedzającego pierwszą procedurę w module kodu programu. Jeśli moduł nie zawiera procedur, metoda AddFromFile umieszcza zawartość pliku na końcu modułu.


AddFromGuid - metoda (Model obiektów stosowany w Dodatkach VBA)
AddFromGuid - metoda

Dodaje do kolekcji References odwołanie, używając globalnie unikatowego identyfikatora (GUID) odwołania.

Składnia

obiekt.AddFromGuid(guid, starszy, młodszy) As Reference

Składnia metody AddFromGuid zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
guid	Element obowiązkowy. Wyrażenie znakowe reprezentujące GUID odwołania.
starszy	Element obowiązkowy. Wartość typu Long określająca bardziej znaczącą część numeru wersji odwołania.
młodszy	Element obowiązkowy. Wartość typu Long określająca mniej znaczącą część numeru wersji odwołania.
Użycie

Metoda AddFromGuid przeszukuje rejestry w celu znalezienia odwołania, które ma zostać dodane. Element GUID może być biblioteką typów, formantem, identyfikatorem klasy itp.


AddFromString - metoda (Model obiektów stosowany w Dodatkach VBA)
AddFromString - metoda

Dodaje tekst do modułu.

Składnia

obiekt.AddFromString

Element obiekt jest wyrażeniem obiektowym określającym obiekt z listy Dotyczy.

Użycie

Metoda AddFromString wstawia tekst począwszy od wiersza poprzedzającego pierwszą procedurę w module. Jeśli moduł nie zawiera procedur, metoda AddFromString umieszcza tekst na końcu modułu.


Close - metoda (Model obiektów stosowany w Dodatkach VBA)
Close - metoda

Zamyka i niszczy okno.

Składnia

obiekt.Close

Element obiekt jest wyrażeniem obiektowym określającym obiekt z listy Dotyczy.

Użycie

Poniżej przedstawiono reakcję różnych typów okien na metodę Close:

•	W przypadku okna będącego okienkiem kodu programu, metoda Close niszczy okienko kodu.

•	W przypadku okna będącego projektantem, metoda Close niszczy zawartego w nim projektanta.

•	W przypadku okien zawsze dostępnych z menu Widok, metoda Close ukrywa okno.


CreateEventProc - metoda (Model obiektów stosowany w Dodatkach VBA)
CreateEventProc - metoda

Tworzy procedurę obsługi zdarzenia.

Składnia

obiekt.CreateEventProc(nazwa_zdarzenia, nazwa_obiektu) As Long

Składnia metody CreateEventProc zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
nazwa_ zdarzenia	Element obowiązkowy. Wyrażenie znakowe określające nazwę zdarzenia, które ma zostać dodane do modułu.
nazwa_ obiektu	Element obowiązkowy. Wyrażenie znakowe określające nazwę obiektu będącego źródłem zdarzenia.
Użycie

Metoda CreateEventProc jest używana do tworzenia procedury obsługi zdarzenia. Na przykład, następujący fragment programu może służyć do utworzenia procedury obsługi zdarzenia dla zdarzenia Click przypisanego do formantu typu Command Button o nazwie Command1. Nazwa CM reprezentuje obiekt typu CodeModule.

TextLocation = CM.CreateEventProc("Click", "Command1")

Metoda CreateEventProc zwraca wiersz rozpoczynający ciało procedury obsługi zdarzenia. Metoda CreateEventProc kończy się niepowodzeniem, jeśli argumenty wskazują na nieistniejące zdarzenie.


DeleteLines - metoda (Model obiektów stosowany w Dodatkach VBA)
DeleteLines - metoda

Usuwa pojedynczy wiersz lub wiersze z podanego zakresu.

Składnia

obiekt.DeleteLines (wiersz_pocz [, licznik])

Składnia metody DeleteLines zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
wiersz_ pocz	Element obowiązkowy. Wartość typu Long określająca pierwszy usuwany wiersz.
licznik	Element nieobowiązkowy. Wartość typu Long określająca liczbę usuwanych wierszy.
Użycie

Jeśli nie określono liczby usuwanych wierszy, metoda DeleteLines usunie jeden wiersz.


Export - metoda (Model obiektów stosowany w Dodatkach VBA)
Export - metoda

Zapisuje składnik jako oddzielny plik lub pliki.

Składnia

obiekt.Export(nazwa_pliku)

Składnia metody Export zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
nazwa_ pliku	Element obowiązkowy. Wartość typu String określająca nazwę pliku, do którego ma zostać wyeksportowany składnik.
Użycie

Jeżeli metoda Export jest używana do zapisywania składnika w osobnym pliku lub plikach, należy podawać nie istniejące nazwy plików; w przeciwnym przypadku wystąpi błąd.


Find - metoda (Model obiektów stosowany w Dodatkach VBA)
Find - metoda

Poszukuje podanego ciągu znaków w aktywnym module.

Składnia

obiekt.Find(cel, wiersz_pocz, kol_pocz, wiersz_końc, kol_końc [, cały_wyraz] [, wielkość_liter] [, szablon]) As Boolean

Składnia metody Find zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
cel	Element obowiązkowy. Wyrażenie typu String zawierające poszukiwany tekst lub szablon.
wiersz_pocz	Element obowiązkowy. Wartość typu Long określająca wiersz, od którego zostanie rozpoczęte poszukiwanie; w przypadku znalezienia przyjmie wartość odpowiadającą wierszowi zawierającemu znaleziony tekst.
kol_pocz	Element obowiązkowy. Wartość typu Long określająca kolumnę, od której ma się rozpocząć poszukiwanie; w przypadku znalezienia przyjmie wartość odpowiadającą kolumnie zawierającej znaleziony tekst.
wiersz_końc	Element obowiązkowy. Wartość typu Long określająca w przypadku znalezienia ostatni wiersz znalezionego tekstu.
kol_końc	Element obowiązkowy. Wartość typu Long określająca w przypadku znalezienia ostatnią kolumnę znalezionego tekstu.
cały_wyraz	Element nieobowiązkowy. Wartość typu Boolean określająca, czy poszukiwania zostaną ograniczone wyłącznie do całych wyrazów. Jeśli wartość wynosi True, poszukiwane będą wyłącznie całe wyrazy. Wartością domyślną jest False.
wielkość_liter	Element nieobowiązkowy. Wartość typu Boolean określająca, czy poszukiwanie będzie przeprowadzane z dokładnością do wielkości liter. Jeśli wartość wynosi True, poszukiwanie odbędzie się z dokładnością do wielkości liter. Wartością domyślną jest False.
szablon	Element nieobowiązkowy. Wartość typu Boolean określająca, czy poszukiwany ciąg znaków jest wzorcem wyrażenia regularnego. Jeśli wartość wynosi True, poszukiwany ciąg znaków jest wzorcem wyrażenia regularnego. Wartością domyślną jest False.
Użycie

Metoda Find zwraca wartość True, jeśli znaleziono ciąg, lub False w przeciwnym przypadku.

Argument wielkość_liter i szablon wzajemnie się wykluczają; jeśli oba przekazywane argumenty mają wartość True, wystąpi błąd.

Metoda Find nie ma wpływu na zawartość okna dialogowego Znajdź.


GetSelection - metoda (Model obiektów stosowany w Dodatkach VBA)
GetSelection - metoda

Zwraca położenie obszaru zaznaczonego w okienku kodu programu.

Składnia

obiekt.GetSelection(wiersz_pocz, kol_pocz, wiersz_końc, kol_końc)

Składnia metody GetSelection zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
wiersz_ pocz	Element obowiązkowy. Wartość typu Long, która zwraca pierwszy wiersz obszaru zaznaczonego w okienku kodu programu.
kol_pocz	Element obowiązkowy. Wartość typu Long, która zwraca pierwszą kolumnę obszaru zaznaczonego w okienku kodu programu.
wiersz_ końc	Element obowiązkowy. Wartość typu Long, która zwraca ostatni wiersz obszaru zaznaczonego w okienku kodu programu.
kol_końc	Element obowiązkowy. Wartość typu Long, która zwraca  ostatnią kolumnę obszaru zaznaczonego w okienku kodu programu.
Użycie

Metoda GetSelection zwraca informacje w argumentach wyjściowych. Dlatego też niezbędne jest przekazanie zmiennych, w których przy powrocie z metody zostaną umieszczone informacje.


Import - metoda (Model obiektów stosowany w Dodatkach VBA)
Import - metoda

Dodaje do projektu składnik z pliku; zwraca ostatnio dodany składnik.

Składnia

obiekt.Import(nazwa_pliku) As VBComponent

Składnia metody Import zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
nazwa_ pliku	Element obowiązkowy. Wartość typu String określająca ścieżkę i nazwę pliku zawierającego składnik, który ma zostać zaimportowany.
Użycie

Metoda Import może zostać użyta do dodania do projektu składnika, formularza, modułu, klasy itp.


InsertLines - metoda (Model obiektów stosowany w Dodatkach VBA)
InsertLines - metoda

Wstawia wiersz lub wiersze kodu w podanym miejscu bloku kodu programu.

Składnia

obiekt.InsertLines(wiersz, kod)

Składnia metody InsertLines zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
wiersz	Element obowiązkowy. Wartość typu Long określająca miejsce, w którym ma zostać wstawiony kod.
kod	Element obowiązkowy. Wartość typu String zawierająca wstawiany kod programu.
Użycie

Jeśli tekst wstawiany przy użyciu metody InsertLines jest separowany sekwencją znaków powrót karetki–nowy wiersz, to zostanie on wstawiony jako osobne, kolejne wiersze.


Item - metoda (Model obiektów stosowany w Dodatkach VBA)
Item - metoda

Zwraca indeksowaną składową kolekcji.

Składnia

obiekt.Item(indeks)

Składnia metody Item zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
indeks	Element obowiązkowy. Wyrażenie określające pozycję składowej kolekcji. Jeśli jest to wyrażenie numeryczne, indeks musi być liczbą od 1 do wartości właściwości Count kolekcji. Jeśli jest to wyrażenie znakowe, indeks musi odpowiadać argumentowi key określonemu uprzednio przy dodawaniu obiektu do kolekcji.
Następująca tabela zawiera listę kolekcji i odpowiadających im argumentów key używanych wraz z metodą Item. Ciąg znaków przekazywanych do metody Item musi odpowiadać argumentowi key kolekcji.

Kolekcja	Wartość argumentu Key
Windows	Ustawienie właściwości Caption
LinkedWindows	Ustawienie właściwości Caption
CodePanes	Z tą właściwością nie jest związany żaden unikatowy ciąg.
VBProjects	Ustawienie właściwości Name
VBComponents	Ustawienie właściwości Name
References	Ustawienie właściwości Name
Properties	Ustawienie właściwości Name
Użycie

Argument indeks może być wartością numeryczną lub ciągiem znaków zawierającym tytuł obiektu.


Lines - metoda (Model obiektów stosowany w Dodatkach VBA)
Lines - metoda

Zwraca wiersze kodu programu z podanego zakresu.

Składnia

obiekt.Lines(wiersz_pocz, licznik) As String

Składnia metody Lines zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
wiersz_ pocz	Element obowiązkowy. Wartość typu Long określająca pierwszy wiersz zwracanego kodu.
licznik	Element obowiązkowy. Wartość typu Long określająca liczbę zwracanych wierszy.
Użycie

Numery wierszy w module kodu programu rozpoczynają się od 1.


ProcBodyLine - metoda (Model obiektów stosowany w Dodatkach VBA)
ProcBodyLine - metoda

Zwraca pierwszy wiersz procedury.

Składnia

obiekt.ProcBodyLine(nazwa_proc, typ_proc) As Long

Składnia metody ProcBodyLine zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
nazwa_ proc	Element obowiązkowy. Wartość typu String zawierająca nazwę procedury.
typ_proc	Element obowiązkowy. Określa typ poszukiwanej procedury. Ponieważ procedury Property mogą mieć wiele reprezentacji w module, konieczne jest określenie typu poszukiwanej procedury. Wszystkie procedury inne niż procedury właściwości (czyli procedury typu Sub i Function) używają stałej vbext_pk_Proc.
Argument typ_proc może przyjmować jako wartość jedną z następujących stałych:

Stała	Opis
vbext_pk_Get	Określa procedurę zwracającą wartość właściwości.
vbext_pk_Let	Określa procedurę przypisującą wartość właściwości.
vbext_pk_Set	Określa procedurę ustawiającą odwołanie do obiektu.
vbext_pk_Proc	Określa wszystkie procedury inne niż procedury właściwości.
Użycie

Pierwszy wiersz procedury jest tym, który zawiera instrukcję Sub, Function lub Property.


ProcCountLines - metoda (Model obiektów stosowany w Dodatkach VBA)
ProcCountLines - metoda

Zwraca liczbę wierszy w podanej procedurze.

Składnia

obiekt.ProcCountLines(nazwa_proc, typ_proc) As Long

Składnia metody ProcCountLines zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
nazwa_ proc	Element obowiązkowy. Wyrażenie typu String zawierające nazwę procedury.
typ_proc	Element obowiązkowy. Określa typ poszukiwanej procedury. Ponieważ procedury Property mogą mieć wiele reprezentacji w module, konieczne jest określenie typu poszukiwanej procedury. Wszystkie procedury inne niż procedury właściwości (czyli procedury typu Sub i Function) używają stałej vbext_pk_Proc.
Argument typ_proc może przyjmować jako wartość jedną z następujących stałych:

Stała	Opis
vbext_pk_Get	Określa procedurę zwracającą wartość właściwości.
vbext_pk_Let	Określa procedurę przypisującą wartość właściwości.
vbext_pk_Set	Określa procedurę ustawiającą odwołanie do obiektu.
vbext_pk_Proc	Określa wszystkie procedury inne niż procedury właściwości.
Użycie

Metoda ProcCountLines zwraca liczbę wszystkich poprzedzających deklarację procedury wierszy pustych lub zawierających komentarze oraz, jeśli procedura jest ostatnią procedurą modułu kodu programu, liczbę wszystkich pustych wierszy występujących po procedurze.


ProcOfLine - metoda (Model obiektów stosowany w Dodatkach VBA)
ProcOfLine - metoda

Zwraca nazwę procedury zawierającą podany wiersz.

Składnia

obiekt.ProcOfLine(wiersz, typ_proc) As String

Składnia metody ProcOfLine zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
wiersz	Element obowiązkowy. Wartość typu Long określająca sprawdzany wiersz.
typ_proc	Element obowiązkowy. Określa typ poszukiwanej procedury. Ponieważ procedury Property mogą mieć wiele reprezentacji w module, konieczne jest określenie typu poszukiwanej procedury. Wszystkie procedury inne niż procedury właściwości (czyli procedury typu Sub i Function) używają stałej vbext_pk_Proc.
Argument typ_proc może przyjmować jako wartość jedną z następujących stałych:

Stała	Opis
vbext_pk_Get	Określa procedurę zwracającą wartość właściwości.
vbext_pk_Let	Określa procedurę przypisującą wartość właściwości.
vbext_pk_Set	Określa procedurę ustawiającą odwołanie do obiektu.
vbext_pk_Proc	Określa wszystkie procedury inne niż procedury właściwości.
Użycie

Wiersz znajduje się w procedurze, jeśli jest wierszem pustym lub komentarzem poprzedzającym deklarację procedury oraz gdy procedura jest ostatnią procedurą modułu kodu programu, jeśli jest pustym wierszem występującym po procedurze.


ProcStartLine - metoda (Model obiektów stosowany w Dodatkach VBA)
ProcStartLine - metoda

Zwraca wiersz rozpoczynający podaną procedurę.

Składnia

obiekt.ProcStartLine(nazwa_proc, typ_proc) As Long

Składnia metody ProcStartLine zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
nazwa_ proc	Element obowiązkowy. Wartość typu String zawierająca nazwę procedury.
typ_proc	Element obowiązkowy. Określa typ poszukiwanej procedury. Ponieważ procedury Property mogą mieć wiele reprezentacji w module, konieczne jest określenie typu poszukiwanej procedury. Wszystkie procedury inne niż procedury właściwości (czyli procedury typu Sub i Function) używają stałej vbext_pk_Proc.
Argument typ_proc może przyjmować jako wartość jedną z następujących stałych:

Stała	Opis
vbext_pk_Get	Określa procedurę zwracającą wartość właściwości.
vbext_pk_Let	Określa procedurę przypisującą wartość właściwości.
vbext_pk_Set	Określa procedurę ustawiającą odwołanie do obiektu.
vbext_pk_Proc	Określa wszystkie procedury inne niż procedury właściwości.
Użycie

Procedura rozpoczyna się od pierwszego wiersza znajdującego się poniżej instrukcji End Sub poprzedzającej procedury. Jeśli procedura jest pierwszą procedurą, rozpoczyna się po zakończeniu ogólnej sekcji Declarations.


Remove - metoda (Model obiektów stosowany w Dodatkach VBA)
Remove - metoda

Usuwa element z kolekcji.

Składnia

obiekt.Remove(składnik)

Składnia metody Remove zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
składnik	Element obowiązkowy. Dla kolekcji LinkedWindows, jest obiektem. Dla kolekcji References, jest odwołaniem do biblioteki typów lub projektu. Dla kolekcji VBComponents, jest stałą wyliczaną reprezentującą moduł klasy, formularz lub moduł standardowy.
Użycie

Metoda Remove stosowana do kolekcji LinkedWindows usuwa okno z kolekcji aktualnie okna połączone. Usunięte okno staje się oknem swobodnym, z własną ramką okien połączonych.


ReplaceLine - metoda (Model obiektów stosowany w Dodatkach VBA)
ReplaceLine - metoda

Zastępuje istniejący wiersz kodu programu podanym wierszem.

Składnia

obiekt.ReplaceLine(wiersz, kod)

Składnia metody ReplaceLine zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
wiersz	Element obowiązkowy. Wartość typu Long określająca położenie zastępowanego wiersza.
kod	Element obowiązkowy. Wartość typu String zawierająca wstawiany kod programu.


SetFocus - metoda (Model obiektów stosowany w Dodatkach VBA)
SetFocus - metoda

Przenosi fokus do podanego okna.

Składnia

obiekt.SetFocus

Element obiekt jest wyrażeniem obiektowym określającym obiekt z listy Dotyczy.

Użycie

Metoda SetFocus jest używana do okien, które są już widoczne.


SetSelection - metoda (Model obiektów stosowany w Dodatkach VBA)
SetSelection - metoda

Dokonuje zaznaczenia w okienku kodu programu.

Składnia

obiekt.SetSelection(wiersz_pocz, kol_pocz, wiersz_końc, kol_końc)

Składnia metody SetSelection zawiera następujące elementy:

Element	Opis
obiekt	Element obowiązkowy. Wyrażenie obiektowe określające obiekt z listy Dotyczy.
wiersz_ pocz	Element obowiązkowy. Wartość typu Long określająca pierwszy wiersz zaznaczanego obszaru.
kol_pocz	Element obowiązkowy. Wartość typu Long określająca pierwszą kolumnę zaznaczanego obszaru.
wiersz_ końc	Element obowiązkowy. Wartość typu Long określająca ostatni wiersz zaznaczanego obszaru.
kol_końc	Element obowiązkowy. Wartość typu Long określająca ostatnią kolumnę zaznaczanego obszaru.


Show - metoda (Model obiektów stosowany w Dodatkach VBA)
Show - metoda

Sprawia, że podane okienko kodu programu staje się w swoim oknie okienkiem widocznym.

Składnia

obiekt.Show

Element obiekt jest wyrażeniem obiektowym określającym obiekt z listy Dotyczy.

Użycie

Metoda Show sprawia, że podane okienko kodu programu staje się w swoim oknie okienkiem posiadającym fokus.


Metoda Add - przykład

W tym przykładzie wykorzystano metodę Add do dodania pojedynczego modułu standardowego do kolekcji VBComponents.

Application.VBE.VBProjects(1).VBComponents.Add(vbext_ct_StdModule)


Metoda AddFromFile - przykład

W tym przykładzie wykorzystano metodę AddFromFile do dodania zawartości pliku do określonego okienka kodu programu.

Application.VBE.CodePanes(3).CodeModule. _

AddFromFile "c:\Programy\book2.frm"


Metoda AddFromGUID - przykład

W tym przykładzie wykorzystano metodę AddFromGUID do dodania odwołania do aktualnego projektu. Do identyfikacji odwołania wykorzystano wartość unikatowego identyfikatora obiektu Reference.

Application.VBE.ActiveVBProject.References. _

AddFromGuid("{000204EF-0000-0000-C000-000000000046}", 5, 0)


Metoda AddFromString - przykład

W tym przykładzie wykorzystano metodę AddFromString do dodania wiersza kodu “Dim intNr As Integer” do określonego okienka kodu programu.

Application.VBE.CodePanes(3).CodeModule. _

AddFromString "Dim intNr As Integer"


Metoda Close - przykład

W tym przykładzie wykorzystano metodę Close do zamknięcia określonego okna będącego elementem kolekcji Windows.

Application.VBE.Windows(9).Close


Metoda CreateEventProc - przykład

W tym przykładzie wykorzystano metodę CreateEventProc do utworzenia procedury typu Button_Click.

Debug.Print _

Application.VBE.SelectVBComponents.CodeModule. _

CreateEventProc("Click", "Button")


Metoda DeleteLines - przykład

Działanie poniższego przykładu przebiega w dwóch etapach. W pierwszej pętli For…Next wykorzystano metodę InsertLines do wstawienia do okienka kodu programu CodePanes(1) 26 wierszy, z których każdy stanowi coraz dłuższy ciąg początkowych liter alfabetu. W pierwszym wierszu znajduje się litera “a”. Ostatni wstawiany wiersz stanowi cały alfabet.

W drugiej pętli For…Next wykorzystano metodę DeleteLines do usunięcia wierszy o numerach nieparzystych. Wydaje się, że druga pętla będzie usuwać wszystkie wiersze po kolei, jednak zauważmy, że po każdej operacji usunięcia następuje przenumerowane wierszy. Po usunięciu wiersza numer kolejnego usuwanego wiersza (zmienna I) wzrasta o 1 i jednocześnie numery wszystkich wierszy występujących za wierszem usuniętym zmniejszają się o 1, co w efekcie daje krok operacji usuwania równy 2.

For I = 1 to 26

Application.VBE.SelectedVBComponent.CodeModule.InsertLines i, _

Mid$("abcdefghijklmnopqrstuvwxyz", 1, I)

Next

For I = 1 to 13

Application.VBE.SelectedVBComponent.CodeModule.DeleteLines I

Next


Metoda Export - przykład

W tym przykładzie tworzony jest plik o nazwie test.bas, a następnie wykorzystana jest metoda Export do skopiowania zawartości modułu programu VBComponents(1) do tego pliku.

Application.VBE.ActiveVBProject.VBComponents(1).Export ("test.bas")


Metoda Find - przykład

W tym przykładzie wykorzystano metodę Find do sprawdzenia, czy określony blok wierszy (od wiersza 1261 do wiersza 1279) w określonym okienku kodu programu zawiera ciąg znaków “Tabs.Clear”.

Application.VBE.CodePanes(2).CodeModule. _

Find ("Tabs.Clear", 1261, 1, 1280, 1, False, False)


Metoda GetSelection - przykład

Poniższy kod programu zwraca położenie punktu początkowego oraz punktu końcowego zaznaczonego fragmentu tekstu w okienku kodu programu CodePanes(1). W ostatnim wierszu przykładu wykorzystano metodę GetSelection do umieszczenia czterech wartości w czterech zmiennych.

Dim m As Long

Dim n As Long

Dim x As Long

Dim y As Long

Application.VBE.CodePanes(1).GetSelection m, n, x, y


Metoda Import - przykład

W tym przykładzie wykorzystano metodę Import kolekcji VBComponents do skopiowania zawartości pliku test.bas do modułu programu.

Application.VBE.ActiveVBProject.VBComponents.Import("test.bas")


Metoda InsertLines - przykład

W tym przykładzie wykorzystano metodę InsertLines do wstawienia wiersza “Option Explicit” do określonego okienka kodu programu.

Application.VBE.CodePanes(1).CodeModule. _

InsertLines 1, "Option Explicit"


Metoda Item - przykład

W tym przykładzie pokazano dwa sposoby wyświetlenia określonego elementu kolekcji CodePanes. W jednym z nich wykorzystano metodę Item.

Application.VBE.CodePanes.Item(2).Show

Application.VBE.CodePanes(2).Show


Metoda Lines - przykład

W tym przykładzie wykorzystano metodę Lines do zwrócenia określonego bloku kodu (wiersze od 1 do 4) w określonym okienku kodu programu.

Debug.Print Application.VBE.CodePanes(1).CodeModule.Lines( 1, 4)


Metoda ProcBodyLine - przykład

W tym przykładzie wykorzystano metodę ProcBodyLine do zwrócenia numeru pierwszego wiersza kodu określonej procedury (SetupTabs) w określonym okienku kodu programu.

Debug.Print Application.VBE.CodePanes(3).CodeModule. _

ProcBodyLine ("SetupTabs", vbext_pk_Proc)


Metoda ProcCountLines - przykład

W tym przykładzie wykorzystano metodę ProcCountLines do zwrócenia liczby wierszy kodu określonej procedury (SetupTabs) w określonym okienku kodu programu.

Debug.Print Application.VBE.CodePanes(3).CodeModule. _

ProcCountLines ("SetupTabs", vbext_pk_Proc)


Metoda ProcOfLine - przykład

W tym przykładzie wykorzystano metodę ProcOfLine do zwrócenia nazwy procedury w określonym okienku kodu programu, zawierającej wiersz o określonym numerze.

Debug.Print Application.VBE.CodePanes(3).CodeModule.ProcOfLine (1270, vbext_pk_Proc)


Metoda ProcStartLine - przykład

W tym przykładzie wykorzystano metodę ProcStartLine do zwrócenia numeru wiersza, od którego rozpoczyna się określona procedura w określonym okienku kodu programu.

Debug.Print Application.VBE.CodePanes(3).CodeModule. _

ProcStartLine ("SetupTabs", vbext_pk_Proc)


Metoda Remove - przykład

Ten przykład prezentuje sposób sprawdzenia, czy określony element kolekcji VBComponents jest modułem. Następnie wykorzystano metodę Remove do usunięcia tego modułu.

Debug.Print Application.VBE.ActiveVBProject.VBComponents(4).Name

Application.VBE.ActiveVBProject.VBComponents. _

Remove Application.VBE.ActiveVBProject.VBComponents(4)


Metoda ReplaceLine - przykład

Działanie tego przykładu przebiega w dwóch etapach. W pierwszej pętli For…Next wykorzystano metodę InsertLines do wstawienia do okienka kodu programu CodePanes(1) 26 wierszy, z których każdy stanowi coraz dłuższy ciąg początkowych liter alfabetu. W pierwszym wierszu znajduje się litera “a”. Ostatni wstawiany wiersz stanowi cały alfabet.

W drugiej pętli For…Next wykorzystano metodę ReplaceLine do zamiany wszystkich wierszy o numerach parzystych na pojedyncze litery będące ostatnimi literami w danym wierszu. Wiersze o numerach nieparzystych pozostają nie zmienione.

For I = 1 to 26

Application.VBE.CodePanes(1).CodeModule. _

InsertLines I, Mid$("abcdefghijklmnopqrstuvwxyz", 1, I)

Next I

For I = 1 to 13

Application.VBE.CodePanes(1).CodeModule. _

ReplaceLine 2*I, Mid$("abcdefghijklmnopqrstuvwxyz", 1, I)

Next I


Metoda SetFocus - przykład

W tym przykładzie wykorzystano metodę SetFocus do przesunięcia fokusu do określonego okna będącego elementem kolekcji Windows. Okno to będzie zachowywać się tak, jakby został kliknięty jego pasek tytułu.

Application.VBE.Windows(9).SetFocus


Metoda SetSelection - przykład

W tym przykładzie wykorzystano metodę SetSelection do zaznaczenia tekstu. Pierwszym zaznaczonym znakiem będzie piąty znak w drugim wierszu okienka kodu programu CodePanes(1), a ostatnim zaznaczonym znakiem będzie piętnasty znak w trzecim wierszu.

Application.VBE.CodePanes(1).SetSelection 2,4,3,15


Metoda Show - przykład

W tym przykładzie wykorzystano metodę Show do przesunięcia określonego okienka kodu programu na pierwszy plan.

Application.VBE.CodePanes(2).Show


Click - zdarzenie (Model obiektu stosowany w Dodatkach VBA)
Click - zdarzenie

Występuje po ustawieniu właściwości OnAction na odpowiednim formancie paska poleceń.

Składnia

Sub obiekt_Click (ByVal ctrl As Object, ByRef handled As Boolean, ByRef canceldefault As Boolean)

Składnia zdarzenia Click ma następujące nazwane argumenty:

Argument	Opis
ctrl	Argument obowiązkowy typu Obiekt. Określa obiekt będący źródłem zdarzenia Click.
handled	Argument obowiązkowy typu Boolean. Jeśli jest równy True, zdarzenie powinno zostać obsłużone przez inne dodatki. Jeśli jest równy False, akcja paska poleceń nie została obsłużona.
canceldefault	Argument obowiązkowy typu Boolean. Jeśli argument jest równy True, wykonywane jest działanie domyślne, o ile nie zostało anulowane przez kolejno wywołany dodatek. Jeśli argument jest równy False, domyślne działanie nie jest wykonywane, o ile nie zostało przywrócone przez wywołany dodatek.
Użycie

Zdarzenie Click jest specyficzne dla obiektu CommandBarEvents. W celu otrzymywania zdarzenia Click dla formantu CommandBar należy użyć zmiennej zadeklarowanej ze słowem kluczowym WithEvents. W tej zmiennej powinna zostać umieszczona zwracana wartość właściwości CommandBarEvents obiektu Events. Właściwość CommandBarEvents pobiera formant CommandBar jako swój argument. Po kliknięciu formantu CommandBar (odpowiadającego zmiennej zadeklarowanej przy użyciu słowa kluczowego WithEvents) wykonywany jest kod programu.


ItemAdded - zdarzenie (Model obiektu stosowany w Dodatkach VBA)
ItemAdded - zdarzenie

Występuje po dodaniu odwołania.

Składnia

Sub obiekt_ItemAdded(ByVal element As Reference)

Obowiązkowy argument element określa dodany element.

Użycie

Zdarzenie ItemAdded występuje po dodaniu obiektu Reference do kolekcji References.


ItemRemoved - zdarzenie (Model obiektu stosowany w Dodatkach VBA)
ItemRemoved - zdarzenie

Występuje po usunięciu odwołania z projektu.

Składnia

Sub obiekt_ItemRemoved(ByVal element As Reference)

Obowiązkowy argument element określa usunięty obiekt Reference.


Zdarzenie Click - przykład

W tym przykładzie pokazano sposób przygotowania kodu dla procedury obsługi zdarzenia Click przy użyciu konstrukcji WithEvents i Set. Należy zwrócić uwagę na zastosowanie w nazwie zdarzenia Click odwołania do obiektu ce zamiast nazwy menu Narzędzia.

Private WithEvents ce As CommandBarEvents

Sub Test()

    Dim c As CommandBarControl

    Set c = Application.VBE.CommandBars("Narzędzia").Controls(1)

    Set ce = Application.VBE.Events.CommandBarEvents(c)

End Sub

Private Sub ce_Click(ByVal CommandBarControl As Object, Handled As _

Boolean, CancelDefault As Boolean)

' W tym miejscu należy wstawić kod procedury obsługi zdarzenia.

End Sub


SelectedVBComponent - właściwość (Model obiektów stosowany w Dodatkach VBA)
SelectedVBComponent - właściwość

Zwraca zaznaczony element. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Właściwość SelectedVBComponent zwraca element zaznaczony w oknie Projekt. Jeśli zaznaczona w oknie Projekt pozycja nie jest elementem, właściwość SelectedVBComponent zwraca wartość Nothing.


ActiveVBProject - właściwość (Model obiektów stosowany w Dodatkach VBA)
ActiveVBProject - właściwość

Zwraca projekt uaktywniony w oknie Projekt. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Właściwość ActiveVBProject zwraca projekt, który został zaznaczony w oknie Projekt lub projekt, którego elementy zostały zaznaczone. W tym ostatnim przypadku, sam projekt nie musi być zaznaczony. Zawsze jakiś projekt jest aktywny, bez względu na to, czy został jawnie zaznaczony, czy też nie.


ActiveWindow - właściwość (Model obiektów stosowany w Dodatkach VBA)
ActiveWindow - właściwość

Zwraca okno, które jest aktywne w środowisku projektowania. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Jeśli w środowisku projektowania otwartych jest kilka okien, właściwość ActiveWindow wyznacza okno, na którym został ustawiony fokus. Jeśli jest to okno główne, właściwość ActiveWindow zwraca wartość Nothing.


Caption - właściwość (Model obiektów stosowany w Dodatkach VBA)
Caption - właściwość

Zwraca wartość typu String zawierającą tytuł aktywnego okna. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Tytuł aktywnego okna jest to tekst wyświetlany na pasku tytułu tego okna.


CodeModule - właściwość (Model obiektów stosowany w Dodatkach VBA)
CodeModule - właściwość

Zwraca obiekt reprezentujący kod programu realizujący obsługę danego elementu. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Jeśli z danym elementem nie jest związany żaden moduł kodu programu, właściwość CodeModule zwraca wartość Nothing.

Uwaga   Obiekt CodePane reprezentuje widoczne okno kodu programu. Dany element może mieć kilka obiektów typu CodePane. Obiekt CodeModule reprezentuje cały kod programu związany z konkretnym elementem. Dany element może więc posiadać tylko jeden obiekt typu CodeModule.


CodePane - właściwość

Zwraca obiekt CodePane. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Jeśli istnieje okienko kodu programu, to zarówno to okienko, jak i okno, które je zawiera, stają się aktywne. Jeśli okienko kodu dla danego modułu nie istnieje, to jest tworzone przez właściwość CodePane.


CodePaneView - właściwość (Model obiektów stosowany w Dodatkach VBA)
CodePaneView - właściwość

Zwraca wartość określającą, czy dane okienko kodu programu działa w trybie widoku Procedury, czy w trybie widok Pełnego Modułu. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

Właściwość CodePaneView może zwracać następujące wartości:

Stała	Opis
vbext_cv_ProcedureView	Określone okienko kodu programu działa w trybie widoku Procedury.
vbext_cv_FullModuleView	Określony projekt jest wyświetlany w trybie widok Pełnego Modułu.


Collection - właściwość (Model obiektów stosowany w Dodatkach VBA)
Collection - właściwość

Zwraca kolekcję zawierającą obiekt podlegający działaniu. Właściwość jest przeznaczona tylko do odczytu.

Użycie

W tym modelu obiektów większość obiektów posiada albo właściwość Parent, albo właściwość Collection; każda z tych właściwości umożliwia wyznaczenie obiektu nadrzędnego w stosunku do danego obiektu.

Za pomocą właściwości Collection można uzyskać dostęp do właściwości, metod i formantów kolekcji, do której należy dany obiekt.


CommandBarEvents - właściwość (Model obiektów stosowany w Dodatkach VBA)
CommandBarEvents - właściwość

Zwraca obiekt CommandBarEvents. Właściwość jest przeznaczona tylko do odczytu.

Ustawienia

Argument właściwości CommandBarEvents musi spełniać następujący warunek:

Argument	Opis
vbformant	Musi być to obiekt typu CommandBarControl.
Użycie

Właściwość CommandBarEvents służy do uzyskania obiektu źródłowego zdarzenia. Obiekt tego typu zgłasza zdarzenie w momencie kliknięcia przez użytkownika na pasku poleceń. Argument przekazywany do właściwości CommandBarEvents musi być formantem z paska poleceń, dla którego ma być obsłużone zdarzenie Click.


Count - właściwość (Model obiektów stosowany w Dodatkach VBA)
Count - właściwość

Zwraca wartość typu Long równą liczbie obiektów w danej kolekcji. Właściwość jest przeznaczona tylko do odczytu.


CountOfLines - właściwość (Model obiektów stosowany w Dodatkach VBA)
CountOfLines - właściwość

Zwraca wartość typu Long równą liczbie wierszy kodu programu w danym module kodu programu. Właściwość jest przeznaczona tylko do odczytu.


CountOfDeclarationLines - właściwość (Model obiektów stosowany w Dodatkach VBA)
CountOfDeclarationLines - właściwość

Zwraca wartość typu Long równą liczbie wierszy kodu składających się na sekcję Deklaracji danego modułu kodu programu. Właściwość jest przeznaczona tylko do odczytu.


CountOfVisibleLines - właściwość (Model obiektów stosowany w Dodatkach VBA)
CountOfVisibleLines - właściwość

Zwraca wartość typu Long równą liczbie wierszy widocznych w okienku kodu programu. Właściwość jest przeznaczona tylko do odczytu.


ActiveCodePane - właściwość (Model obiektów stosowany w Dodatkach VBA)
ActiveCodePane - właściwość

Zwraca aktualnie aktywny lub ostatnio aktywny obiekt CodePane albo uaktywnia wybrany obiekt CodePane. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Właściwość ActiveCodePane może uaktywnić dowolny prawidłowy obiekt CodePane, tak jak w poniższym przykładzie:

Set MyApp.VBE.ActiveCodePane = MyApp.VBE.CodePanes(1)

W tym przykładzie uaktywnione zostało pierwsze okienko kodu programu z kolekcji okienek kodu programu. Odpowiednie okienko kodu programu można też uaktywnić za pomocą metody Set.


Description - właściwość (Model obiektów stosowany w Dodatkach VBA)
Description - właściwość

Zwraca lub ustawia wyrażenie znakowe stanowiące opis obiektu. Dla obiektu VBProject właściwość jest przeznaczona do odczytu i do zapisu, a dla obiektu Reference tylko do odczytu.

Użycie

Dla obiektu VBProject właściwość Description umożliwia odczytanie lub przypisanie ciągu znaków stanowiącego opis aktywnego projektu.

Dla obiektu Reference właściwość Description zwraca opisową nazwę danego odwołania.


Designer - właściwość (Model obiektów stosowany w Dodatkach VBA)
Designer - właściwość

Zwraca obiekt udostępniający dane projektowe określonego elementu.

Użycie

Jeśli dla danego obiektu został otwarty projektant, właściwość Designer zwraca obiekt reprezentujący tego projektanta; jeśli nie - tworzony jest nowy projektant. Dla pewnych rodzajów obiektów typu VBComponent projektant obiektu zawiera jego charakterystykę. Oznacza to na przykład, że przy tworzeniu niektórych rodzajów obiektów typu VBComponent powstają również odpowiadający im projektanci. Każdy element może mieć tylko jednego projektanta i jest to zawsze ten sam projektant. Właściwość Designer umożliwia więc dostęp do obiektu zawierającego dane specyficzne dla danego elementu. W przypadku modułu standardowego i modułu klasy, projektant nie jest tworzony, gdyż tego rodzaju obiekty typu VBComponent nie mają projektantów.

Jeśli dany obiekt VBComponent nie ma projektanta, właściwość Designer zwraca wartość Nothing.


DesignerWindow - właściwość (Model obiektów stosowany w Dodatkach VBA)
DesignerWindow - właściwość

Zwraca obiekt Window reprezentujący projektanta danego elementu.

Użycie

Jeśli dla danego elementu może zostać utworzony projektant, ale projektant nie jest w danym momencie otwarty, to zastosowanie właściwości DesignerWindow spowoduje utworzenie tego projektanta, przy czym nie będzie on widoczny. Aby wyświetlić okno projektanta, należy właściwości Visible zwróconego obiektu Window nadać wartość True.


CodePanes - właściwość (Model obiektów stosowany w Dodatkach VBA)
CodePanes - właściwość

Zwraca kolekcję aktywnych obiektów CodePane. Właściwość jest przeznaczona tylko do odczytu.


GUID - właściwość (Model obiektów stosowany w Dodatkach VBA)
GUID - właściwość

Zwraca wartość typu String stanowiącą identyfikator klasy obiektu. Właściwość jest przeznaczona tylko do odczytu.


HasOpenDesigner - właściwość (Model obiektów stosowany w Dodatkach VBA)
HasOpenDesigner - właściwość

Zwraca wartość typu Boolean określającą, czy projektant danego obiektu VBComponent jest otwarty. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

Właściwość HasOpenDesigner może zwracać następujące wartości:

Wartość	Opis
True	Okno Projektanta obiektu VBComponent jest otwarte.
False	Okno Projektanta obiektu VBComponent nie zostało otwarte.


Height - właściwość (Model obiektów stosowany w Dodatkach VBA)
Height - właściwość

Zwraca lub ustawia wartość typu Single równą wysokości okna, wyrażonej w jednostkach zwanych twip. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Zmiana wartości właściwości Height okna połączonego lub okna zadokowanego nie wywoła żadnego skutku, dopóki okno pozostaje połączone lub zadokowane.


HelpContextID - właściwość (Model obiektów stosowany w Dodatkach VBA)
HelpContextID - właściwość

Zwraca lub ustawia wartość typu String stanowiącą identyfikator tematu w pliku Pomocy Microsoft Windows. Właściwość jest przeznaczona do odczytu i do zapisu.


HelpFile - właściwość (Model obiektów stosowany w Dodatkach VBA)
HelpFile - właściwość

Zwraca lub ustawia wartość typu String określającą plik Pomocy Microsoft Windows właściwy dla danego projektu. Właściwość jest przeznaczona do odczytu i do zapisu.


IndexedValue - właściwość (Model obiektów stosowany w Dodatkach VBA)
IndexedValue - właściwość

Dla właściwości, która jest listą indeksową lub tablicą, zwraca lub ustawia wartość wybranej składowej.

Użycie

Wartość zwracana lub ustawiana przez właściwość IndexedValue jest wyrażeniem, którego typ jest odpowiedni dla danego obiektu. Dla właściwości obiektu, która jest listą indeksowaną lub tablicą konieczne jest stosowanie właściwości IndexedValue zamiast właściwości Value. Indeks jest wyrażeniem numerycznym określającym pozycję elementu.

Właściwość IndexedValue przyjmuje do 4 indeksów. Liczbę indeksów przyjmowanych przez właściwość IndexedValue można wyznaczyć za pomocą właściwości NumIndices.

Właściwość IndexedValue może być używana tylko w przypadku, gdy wartość właściwości NumIndices jest większa niż zero. Wartości elementów list indeksowanych są wyznaczane lub ustawiane za pomocą pojedynczego indeksu.


IsBroken - właściwość (Model obiektów stosowany w Dodatkach VBA)
IsBroken - właściwość

Zwraca wartość typu Boolean określającą, czy obiekt typu Reference wskazuje prawidłowe odwołanie w rejestrze. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

Właściwość IsBroken może zwracać następujące wartości:

Wartość	Opis
True	Obiekt Reference już nie wskazuje prawidłowego odwołania w rejestrze.
False	Obiekt Reference nadal wskazuje prawidłowe odwołanie w rejestrze.


BuiltIn - właściwość (Model obiektów stosowany w Dodatkach VBA)
BuiltIn - właściwość

Zwraca wartość typu Boolean określającą, czy dane odwołanie jest odwołaniem domyślnym i w związku z tym nie może być usunięte. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

Właściwość BuiltIn może zwracać następujące wartości:

Wartość	Opis
True	Odwołanie jest odwołaniem domyślnym i nie może być usunięte.
False	Odwołanie nie jest odwołaniem domyślnym i może być usunięte.


Saved - właściwość (Model obiektów stosowany w Dodatkach VBA)
Saved - właściwość

Zwraca wartość typu Boolean określającą, czy obiekt podlegał edycji od ostatniego zapisu. Właściwość jest przeznaczona do odczytu i do zapisu.

Wartości zwracane

Właściwość Saved może zwracać następujące wartości:

Wartość	Opis
True	Obiekt nie podlegał edycji od ostatniego zapisu.
False	Obiekt podlegał edycji od ostatniego zapisu.
Użycie

Metoda SaveAs nadaje właściwości Saved wartość True.

Uwaga   Jeśli właściwości Saved została programowo przypisana wartość False, to wartością właściwości będzie False, a obiekt zostanie oznaczony jako zmieniony od ostatniego zapisu.


Left - właściwość (Model obiektów stosowany w Dodatkach VBA)
Left - właściwość

Zwraca lub ustawia wartość typu Single określającą pozycję lewej krawędzi okna na ekranie, wyrażoną w jednostkach zwanych twip. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Wartość zwracana przez właściwość Left zależy od tego, czy dane okno jest oknem połączonym lub oknem zadokowanym, czy nie.

Uwaga   Zmiana wartości właściwości Left okna połączonego lub zadokowanego nie wywoła żadnego skutku, dopóki okno pozostaje połączone lub zadokowane.


LinkedWindowFrame - właściwość (Model obiektów stosowany w Dodatkach VBA)
LinkedWindowFrame - właściwość

Zwraca obiekt Window reprezentujący ramkę zawierającą dane okno. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Właściwość LinkedWindowFrame udostępnia obiekt reprezentujący ramkę okien połączonych, która ma właściwości inne niż okno lub okna w niej zawarte. Jeśli okno nie jest oknem połączonym, właściwość LinkedWindowFrame zwraca wartość Nothing.


FullPath - właściwość (Model obiektów stosowany w Dodatkach VBA)
FullPath - właściwość

Zwraca wartość typu String określającą ścieżkę dostępu i nazwę pliku biblioteki typów, do której odnosi się odwołanie. Właściwość jest przeznaczona tylko do odczytu.


MainWindow - właściwość (Model obiektów stosowany w Dodatkach VBA)
MainWindow - właściwość

Zwraca obiekt Window reprezentujący główne okno środowiska projektowania systemu Visual Basic. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Obiekt Window zwracany przez właściwość MainWindow może służyć do dodawania lub usuwania okien zadokowanych. Za pomocą obiektu Window zwróconego przez właściwość MainWindow można także maksymalizować, minimalizować, ukrywać lub odtwarzać główne okno środowiska projektowania systemu Visual Basic.


Major - właściwość (Model obiektów stosowany w Dodatkach VBA)
Major - właściwość

Zwraca wartość typu Long będącą starszą częścią numeru wersji biblioteki typów, do której odnosi się odwołanie. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Liczba zwracana przez właściwość Major odpowiada starszej części numeru wersji przechowywanego w bibliotece typów, do której zostało ustawione odwołanie.


Minor - właściwość (Model obiektów stosowany w Dodatkach VBA)
Minor - właściwość

Zwraca wartość typu Long będącą młodszą częścią numeru wersji biblioteki typów, do której odnosi się odwołanie. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Liczba zwracana przez właściwość Major odpowiada młodszej części numeru wersji przechowywanego w bibliotece typów, do której zostało ustawione odwołanie.


Mode - właściwość (Model obiektów stosowany w Dodatkach VBA)
Mode - właściwość

Zwraca wartość określającą tryb działania określonego projektu. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

Właściwość Mode może zwracać następujące wartości:

Stała	Opis
vbext_vm_RunMode	Określony projekt znajduje się w trybie działania aplikacji.
vbext_vm_BreakMode	Określony projekt znajduje się w trybie przerwania.
vbext_vm_DesignMode	Określony projekt znajduje się w trybie projektowania.


Name - właściwość (Model obiektów stosowany w Dodatkach VBA)
Name - właściwość

Zwraca lub ustawia wartość typu String stanowiącą nazwę używaną w kodzie programu do identyfikacji danego obiektu. Dla obiektów typu VBProject i VBComponent właściwość jest przeznaczona do odczytu i do zapisu, dla obiektów typu Property i Reference właściwość jest przeznaczona tylko do odczytu.

Użycie

Poniższa tabela opisuje efekt działania właściwości Name w zależności od typu obiektu.

Obiekt	Efekt zastosowania właściwości Name
VBProject	Zwraca lub ustawia nazwę aktywnego projektu.
VBComponent	Zwraca lub ustawia nazwę elementu. W przypadku przypisania właściwości Name nazwy nieprawidłowej lub aktualnie używanej generowany jest błąd.
Property	Zwraca nazwę właściwości w takiej postaci, w jakiej jest ona wyświetlana w oknie Właściwości. Poprzez tę nazwę można odwoływać się do odpowiadającego jej elementu z kolekcji Properties. Nazwa właściwości jest przeznaczona tylko do odczytu.
Reference	Zwraca nazwę odwołania wykorzystywaną w kodzie programu. Nazwa jest przeznaczona tylko do odczytu.
Domyślna nazwa nowego obiektu składa się z typu obiektu i unikatowej liczby całkowitej. Na przykład, pierwszy obiekt typu Form zostanie nazwany Form1, następny Form2, a trzeci formant typu TextBox utworzony w danym formularzu będzie miał nazwę TextBox3.

Właściwość Name obiektu musi rozpoczynać się od litery i nie może mieć więcej niż 40 znaków. Może zawierać cyfry i znaki podkreślenia (_), ale nie może zawierać znaków przestankowych i spacji. Formularze i moduły nie mogą mieć takich samych nazw jak inne obiekty publiczne, takie jak Clipboard, Screen lub App. Wartość nadana właściwości Name może być identyczna jak słowo kluczowe, nazwa właściwości lub nazwa innego obiektu, należy jednak pamiętać, że takie rozwiązanie może prowadzić do konfliktów nazw w kodzie programu.


NumIndices - właściwość (Model obiektów stosowany w Dodatkach VBA)
NumIndices - właściwość

Zwraca liczbę indeksów wymaganych przez właściwości obiektu reprezentowaną przez obiekt Property.

Użycie

Wartość właściwości NumIndices może być liczbą z przedziału 0 - 4. Dla większości właściwości wartość właściwości NumIndices wynosi 0. Typowe właściwości indeksowane wymagają jednego indeksu. W przypadku tablic mogą to być dwa indeksy.


Object - właściwość (Model obiektów stosowany w Dodatkach VBA)
Object - właściwość

Zwraca lub ustawia wartość obiektu zwróconego przez daną właściwość. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Jeśli właściwość zwraca obiekt, to do ustawiania lub odczytywania wartości tego obiektu musi być używana właściwość Object.


Parent - właściwość (Model obiektów stosowany w Dodatkach VBA)
Parent - właściwość

Zwraca obiekt lub kolekcję zawierającą dany obiekt lub kolekcję. Właściwość jest przeznaczona tylko do odczytu.

Użycie

W tym modelu obiektów większość obiektów posiada właściwość Parent albo właściwość Collection; każda z tych właściwości umożliwia wyznaczenie obiektu nadrzędnego w stosunku do danego obiektu. Jeśli obiektem nadrzędnym dla danego obiektu jest kolekcja, to należy stosować właściwość Collection.

Za pomocą właściwości Parent można uzyskać dostęp do właściwości, metod i formantów obiektu nadrzędnego w stosunku do danego obiektu.


Protection - właściwość (Model obiektów stosowany w Dodatkach VBA)
Protection - właściwość

Zwraca wartość określającą rodzaj zabezpieczenia projektu. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

Właściwość Protection może zwracać następujące wartości:

Stała	Opis
vbext_pp_locked	Określony projekt jest zablokowany.
vbext_pp_none	Określony projekt nie jest chroniony.


ReferencesEvents - właściwość (Model obiektów stosowany w Dodatkach VBA)
ReferencesEvents - właściwość

Zwraca obiekt ReferencesEvents. Właściwość jest przeznaczona tylko do odczytu.

Ustawienia

Interpretacja argumentu właściwości ReferencesEvents jest następująca:

Argument	Opis
vbprojekt	Jeśli argument vbprojekt ma wartość Nothing, to obiekt zwracany będzie generował zdarzenia dotyczące kolekcji References wszystkich obiektów typu VBProject z kolekcji VBProjects.  Jeśli argument vbprojekt wskazuje prawidłowy obiekt typu VBProject, to zwrócony obiekt będzie generował zdarzenia wyłącznie dla kolekcji References wskazanego projektu.
Użycie

Właściwość ReferencesEvents analizuje argument i zwraca obiekt źródłowy zdarzenia. Obiekt ReferencesEvents generuje zdarzenia odpowiadające dodawaniu lub usuwaniu odwołań.


Top - właściwość (Model obiektów stosowany w Dodatkach VBA)
Top - właściwość

Zwraca lub ustawia wartość typu Single określającą pozycję górnej krawędzi okna na ekranie, wyrażoną w jednostkach zwanych twip. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Wartość zwracana przez właściwość Top zależy od tego, czy dane okno jest oknem zadokowanym, oknem połączonym lub czy działa w trybie widoku dokowania.

Uwaga   Zmiana wartości właściwości Top okna połączonego lub zadokowanego nie wywoła żadnego skutku, dopóki okno pozostaje połączone lub zadokowane.


TopLine - właściwość (Model obiektów stosowany w Dodatkach VBA)
TopLine - właściwość

Zwraca wartość typu Long równą numerowi pierwszego od góry wiersza wyświetlanego w okienku kodu programu lub określa, który wiersz będzie pierwszym od góry wierszem wyświetlanym w okienku kodu programu. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Właściwości TopLine należy używać do odczytywania lub podawania numeru pierwszego od góry wiersza wyświetlanego w okienku kodu programu. Na przykład, jeśli pierwszym od góry wierszem wyświetlanym w okienku kodu programu ma być wiersz nr 25, to należy właściwości TopLine przypisać wartość 25.

Wartość, którą można przypisać właściwości TopLine, musi być liczbą dodatnią. Jeśli właściwość TopLine ma wartość większą niż liczba wierszy wyświetlanych w okienku, to jako pierwszy wiersz od góry zostanie przyjęty ostatni wiersz kodu programu z okienka.


Type - właściwość (Model obiektów stosowany w Dodatkach VBA)
Type - właściwość

Zwraca lub ustawia wartość numeryczną lub znakową odpowiadającą typowi obiektu. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

W poniższej tabeli została przedstawiona interpretacja wartości zwracanych przez właściwość Type obiektu Window.

Stała	Wartość	Opis
vbext_wt_CodeWindow	0	Okno Kod programu
vbext_wt_Designer	1	Okno Projektanta
vbext_wt_Browser	2	Przeglądarka obiektów
vbext_wt_Watch	3	Okno czujek
vbext_wt_Locals	4	Okno zmiennych lokalnych
vbext_wt_Immediate	5	Okno instrukcji bezpośrednich
vbext_wt_ProjectWindow	6	Okno Projekt
vbext_wt_PropertyWindow	7	Okno Właściwości
vbext_wt_Find	8	Okno dialogowe Znajdź
vbext_wt_FindReplace	9	Okno dialogowe Znajdź i zamień
vbext_wt_LinkedWindowFrame	11	Ramka okien połączonych
vbext_wt_MainWindow	12	Okno główne
W poniższej tabeli została przedstawiona interpretacja wartości zwracanych przez właściwość Type obiektu VBComponent.

Stała	Opis
vbext_ct_ClassModule	Moduł klasy
vbext_ct_MSForm	Formularz
vbext_ct_StdModule	Moduł standardowy
vbext_ct_Document	Moduł dokumentu
W poniższej tabeli została przedstawiona interpretacja wartości zwracanych przez właściwość Type obiektu Reference.

Stała	Opis
vbext_rk_TypeLib	Biblioteka typów
vbext_rk_Project	Projekt


Value - właściwość (Model obiektów stosowany w Dodatkach VBA)
Value - właściwość

Zwraca lub ustawia wartość typu Variant stanowiącą wartość danej właściwość. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Ponieważ właściwość Value zwraca wartość typu Variant, można za jej pomocą odczytać wartość dowolnej właściwości. Aby odczytać wartość z listy, należy użyć właściwości IndexedValue.

Jeśli właściwość reprezentowana przez dany obiekt Property może być zarówno odczytywana, jak i zmieniana, to właściwość Value jest przeznaczona do odczytu i do zapisu. Jeśli dana właściwość może być tylko odczytywana, to próba przypisania właściwości Value wartości spowoduje błąd. Jeśli dana właściwość może być tylko ustawiana, to próba odczytania właściwości Value spowoduje błąd.

Właściwość Value jest właściwością domyślną obiektu Property.


VBE - właściwość (Model obiektów stosowany w Dodatkach VBA)
VBE - właściwość

Wskazuje obiekt nadrzędny obiektu VBE. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Wszystkie obiekty posiadają właściwość VBE wskazującą na obiekt nadrzędny obiektu VBE.


Version - właściwość (Model obiektów stosowany w Dodatkach VBA)
Version - właściwość

Zwraca lub ustawia wartość typu String odpowiadającą wersji systemu Visual Basic for Applications, którego używa aplikacja. Właściwość jest przeznaczona tylko do odczytu.

Użycie

Wartość właściwości Version jest ciągiem znaków rozpoczynających się od jednej lub dwóch cyfr, po których następuje kropka i dwie cyfry. Pozostała część ciągu nie jest ściśle zdefiniowana i może zawierać zarówno tekst, jak i liczby.


Visible - właściwość (Model obiektów stosowany w Dodatkach VBA)
Visible - właściwość

Dla obiektu Window zwraca lub ustawia wartość typu Boolean, która określa, czy okno jest widoczne. Właściwość jest przeznaczona do odczytu i do zapisu. Dla obiektu CodePane właściwość zwraca wartość typu Boolean określającą, czy okienko kodu programu jest widoczne w oknie. Właściwość jest przeznaczona tylko do odczytu.

Wartości zwracane

Właściwość Visible może zwracać następujące wartości:

Wartość	Opis
True	(Domyślna) Obiekt jest widoczny.
False	Obiekt jest ukryty.


Width - właściwość (Model obiektów stosowany w Dodatkach VBA)
Width - właściwość

Zwraca lub ustawia wartość typu Single równą szerokości okna, wyrażonej w jednostkach zwanych twip. Właściwość jest przeznaczona do odczytu i do zapisu.

Użycie

Zmiana wartości właściwości Width okna połączonego lub okna zadokowanego nie wywoła żadnego skutku, dopóki okno pozostaje połączone lub zadokowane.


Window - właściwość (Model obiektów stosowany w Dodatkach VBA)
Window - właściwość

Zwraca okno, w którym wyświetlane jest okienko kodu programu. Właściwość jest przeznaczona tylko do odczytu.


WindowState - właściwość (Model obiektów stosowany w Dodatkach VBA)
WindowState - właściwość

Zwraca lub ustawia wartość typu numerycznego określającą sposób wyświetlania okna. Właściwość jest przeznaczona do odczytu i do zapisu.

Ustawienia

Właściwość WindowState może zwracać lub przybierać następujące wartości:

Stała	Wartość	Opis
vbext_ws_Normal	0	(Domyślna) Wielkość normalna
vbext_ws_Min	1	Wielkość minimalna (ikona)
vbext_ws_Max	2	Wielkość maksymalna (powiększone do maksymalnego rozmiaru)


Właściwość ActiveCodePane - przykład

W tym przykładzie wykorzystano właściwość ActiveCodePane oraz właściwość TopLine do uzyskania numeru pierwszego wiersza w aktywnym okienku kodu programu.

Debug.Print Application.VBE.ActiveCodePane.TopLine


Właściwość ActiveVBProject - przykład

W tym przykładzie wykorzystano właściwość ActiveVBProject do zwrócenia nazwy aktywnego projektu.

Debug.Print Application.VBE.ActiveVBProject.Name


Właściwość ActiveWindow - przykład

W tym przykładzie wykorzystano właściwość ActiveWindow do zwrócenia nazwy aktywnego okna.

Debug.Print Application.VBE.ActiveWindow.Caption


Właściwość BuiltIn - przykład

W tym przykładzie wykorzystano właściwość BuiltIn do zwrócenia wartości typu Boolean umożliwiającej stwierdzenie, czy określone odwołanie w aktywnym projekcie jest odwołaniem wbudowanym.

Debug.Print Application.VBE.ActiveVBProject.References(1).BuiltIn


Właściwość Caption - przykład

W tym przykładzie wykorzystano właściwość Caption do wyświetlenia nazwy aktywnego okna.

Debug.Print Application.VBE.ActiveWindow.Caption


Właściwość CodeModule - przykład

W tym przykładzie wykorzystano właściwości CodeModule i CountOfLines do zwrócenia liczby wierszy w określonym module kodu programu.

Debug.Print _

Application.VBE.ActiveVBProject.VBComponents(6).CodeModule. _

CountOfLines


Właściwość CodePane - przykład

W tym przykładzie wykorzystano właściwości CodePane i TopLine do wyświetlenia numeru pierwszego wiersza modułu kodu programu zaznaczonego obiektu VBComponent.

Debug.Print _

Application.VBE.SelectedVBComponent.CodeModule.CodePane.TopLine


Właściwość CodePanes - przykład

W tym przykładzie wykorzystano właściwości CodePanes i TopLine do wyświetlenia numeru pierwszego wiersza w określonym okienku kodu programu.

Debug.Print Application.VBE.CodePanes(3).TopLine


Właściwość CodePaneView - przykład

W tym przykładzie wykorzystano właściwość CodePaneView do zwrócenia wartości określającej, czy dane okienko kodu programu znajduje się w trybie widoku procedury czy w trybie pełnego widoku modułu.

Debug.Print Application.VBE.CodePanes(3).CodePaneView


Właściwość Collection - przykład

W tym przykładzie wykorzystano właściwości Collection i Count do zwrócenia liczby obiektów w aktywnym projekcie traktowanym jako kolekcja obiektów.

Debug.Print Application.VBE.ActiveVBProject.Collection.Count


Właściwość CommandBarEvents - przykład

W tym przykładzie zaprezentowano kod programu wykorzystujący właściwość CommandBarEvents. Korzystając z tego przykładu, można zdefiniować własną obsługę kliknięć elementów paska poleceń.

Private WithEvents ce As CommandBarEvents

Sub Test()

    Dim c As CommandBarControl

    Set c = Application.VBE.CommandBars("Narzędzia").Controls(1)

    Set ce = Application.VBE.Events.CommandBarEvents(c)

End Sub

Private Sub ce_Click(ByVal CommandBarControl As Object, _

    Handled As Boolean, CancelDefault As Boolean)

    ' W tym miejscu należy umieścić obsługę zdarzenia

End Sub


Właściwość Count - przykład

W tym przykładzie wykorzystano właściwość Count do zwrócenia liczby obiektów VBComponent w określonym projekcie.

Debug.Print Application.VBE.VBProjects(1).VBComponents.Count


Właściwość CountOfDeclarationLines - przykład

W tym przykładzie wykorzystano właściwość CountOfDeclarationLines do zwrócenia liczby wierszy deklaracji znajdujących się w określonym okienku kodu programu.

Debug.Print _

Application.VBE.CodePanes(2).CodeModule.CountOfDeclarationLines


Właściwość CountOfLines - przykład

W tym przykładzie wykorzystano właściwość CountOfLines do zwrócenia całkowitej liczby wierszy w określonym okienku kodu programu.

Application.VBE.CodePanes(2).CodeModule.CountOfLines


Właściwość CountOfVisibleLines - przykład

W tym przykładzie wykorzystano właściwość CountOfVisibleLines do zwrócenia liczby wierszy widocznych naraz w określonym okienku kodu programu, co zależy od wysokości okienka.

Debug.Print Application.VBE.Codepanes(3).CountOfVisibleLines


Właściwość Description - przykład

W pierwszym z poniższych przykładów wykorzystano właściwość Description do przypisania opisu do określonego projektu. Następnie opis ten jest drukowany do sprawdzenia poprawności operacji przypisania.

W drugim przykładzie wykorzystano właściwość Description do zwrócenia opisowych nazw określonych obiektów Reference w danym projekcie.

Application.VBE.VBProjects(1).Description = "Danie specjalne"

Debug.Print Application.VBE.VBProjects(1).Description

Debug.Print Application.VBE.VBProjects(1).References(1).Description

Debug.Print Application.VBE.VBProjects(1).References(2).Description


Właściwość Designer - przykład

W tym przykładzie wykorzystano właściwości Designer i Count do zwrócenia liczby formantów formularza. Zauważmy, że okno zawierające formularz musi być wybrane. Obiekt Designer sam stanowi formularz.

Debug.Print Application.VBE.SelectVBComponent.Designer.Controls.Count


Właściwość DesignerWindow - przykład

W tym przykładzie wykorzystano właściwości DesignerWindow i Visibile do stwierdzenia, czy określony projektant jest widoczny. Zauważmy, że obiekt VBComponent musi być formularzem.

Debug.Print _

Application.VBE.VBProjects(1).VBComponents(1).DesignerWindow. _

Visible


Właściwość FullPath - przykład

W tym przykładzie wykorzystano właściwość FullPath do zwrócenia nazwy pełnej ścieżki dostępu do biblioteki obiektów wskazywanej przez określone odwołanie.

Debug.Print Application.VBE.ActiveVBProject.References(1).FullPath


Właściwość GUID - przykład

W tym przykładzie wykorzystano właściwość GUID do zwrócenia globalnie unikatowego numeru identyfikacyjnego określonego obiektu Reference w danym projekcie.

Debug.Print Application.VBE.VBProjects(1).References(1).GUID


Właściwość HasOpenDesigner - przykład

W tym przykładzie wykorzystano właściwość HasOpenDesigner do stwierdzenia, czy dla określonego składnika danego projektu (w tym przypadku formularza) istnieje otwarty projektant.

Debug.Print _

Application.VBE.VBProjects(1).VBComponents(1).HasOpenDesigner


Właściwości Height, Width Properties - przykład

W tym przykładzie wykorzystano właściwości Height i Width do zwrócenia wysokości i szerokości określonego okna, w jednostkach zwanych twip. Te wartości właściwości ulegają zmianie po połączeniu lub zadokowaniu okna, ponieważ odnoszą się one do obiektu Window, z którym oryginalne okno zostało połączone lub do którego zostało zadokowane.

Debug.Print Application.VBE.Windows(9).Height

Debug.Print Application.VBE.Windows(9).Width


Właściwość HelpContextID - przykład

W tym przykładzie wykorzystano właściwość HelpContextID do zwrócenia identyfikatora Pomocy kontekstowej w pliku Pomocy związanego z projektem.

Debug.Print Application.VBE.VBProjects(1).HelpContextID


Właściwośći HelpFile - przykład
Właściwość HelpFile - przykład

W tym przykładzie wykorzystano właściwość HelpFile do przypisania pliku Pomocy do projektu. W przykładzie następuje sprawdzenie poprawności operacji przypisania drogą wydrukowania pełnej nazwy ścieżki dostępu do pliku Pomocy.

Application.VBE.VBProjects(1).HelpFile = "C:\PlikiPomocy\veenob3.hlp"

Debug.Print Application.VBE.VBProjects(1).HelpFile


Właściwość IsBroken - przykład

W tym przykładzie wykorzystano właściwość IsBroken do zwrócenia wartości informującej, czy określony obiekt Reference danego projektu reprezentuje odwołanie, które jest już nieaktualne.

Debug.Print Application.VBE.vbprojects(1).References(1).IsBroken


Właściwości Left, Top Properties - przykład

W tym przykładzie wykorzystano właściwości Left i Top do zwrócenia współrzędnych lewego górnego rogu określonego okna, w jednostkach zwanych twip. Te wartości właściwości ulegają zmianie po połączeniu lub zadokowaniu okna, ponieważ odnoszą się one do obiektu Window, z którym oryginalne okno zostało połączone lub do którego zostało zadokowane.

Debug.Print Application.VBE.Windows(9).Left

Debug.Print Application.VBE.Windows(9).Top


Właściwość MainWindow - przykład

W tym przykładzie wykorzystano właściwość MainWindow do zwrócenia obiektu Window reprezentującego okno główne, a następnie do wydrukowania nazwy tego okna.

Debug.Print Application.VBE.MainWindow.Caption


Właściwość Major - przykład

W tym przykładzie wykorzystano właściwość Major do zwrócenia starszej części numeru wersji określonego obiektu Reference w danym projekcie.

Debug.Print Application.VBE.VBProjects(1).References(1).Major


Właściwość Minor - przykład

W tym przykładzie wykorzystano właściwość Minor celu zwrócenia młodszej części numeru wersji określonego obiektu Reference w danym projekcie.

Debug.Print Application.VBE.VBProjects(1).References(1).Minor


Właściwość Mode - przykład

W tym przykładzie wykorzystano właściwość Mode do zwrócenia trybu aktywnego projektu. Zwrócona wartość jest predefiniowaną stałą określającą tryb projektu.

Debug.Print Application.VBE.ActiveVBProject.Mode


Właściwość Name - przykład

W tym przykładzie wykorzystano właściwość Name do zwrócenia nazwy określonego elementu kolekcji VBComponents w danym projekcie.

Debug.Print Application.VBE.VBProjects(1).VBComponents(1).Name


Właściwość NumIndices - przykład

W tym przykładzie wykorzystano właściwość NumIndices do zwrócenia liczby indeksów należących do określonej właściwości danego obiektu VBComponent.

Debug.Print _

Application.VBE.VBProjects(1).VBComponents(1).Properties(40). _

NumIndices


Właściwość Object - przykład

W tym przykładzie następuje umieszczenie nazwy ikony na liście ikon określonego obiektu. Obiekt ten musi być formularzem.

Set _

Application.VBE.ActiveVBProject.VBComponents(1). _

Properties("Icon").Object = LoadPicture("Baseball.ico")


Właściwość Parent - przykład

W tym przykładzie wykorzystano właściwość Parent obiektu do zwrócenia nazwy jego obiektu nadrzędnego (“rodzica”) w hierarchii obiektów.

Debug.Print Application.VBE.ActiveVBProject.VBComponents.Parent.Name


Właściwość Protection - przykład

W tym przykładzie wykorzystano właściwość Protection do zwrócenia wartości określającej, czy projekt jest zabezpieczony. Zwrócona wartość jest liczbą odpowiadającą predefiniowanej stałej reprezentującej status projektu.

Debug.Print Application.VBE.ActiveVBProject.Protection


Właściwość ReferencesEvents - przykład

W tym przykładzie zaprezentowano kod programu wykorzystujący właściwość ReferencesEvents. Na bazie tego przykładu można utworzyć obsługę zdarzeń dodawania lub usuwania odwołań.

Private WithEvents X As ReferencesEvents

Sub Test()

    Set X = Application.VBE.Events.ReferencesEvents

End Sub

Private Sub X_ItemAdded(ByVal Reference As VBIDE.Reference)

    ' W tym miejscu należy umieścić kod obsługujący dodawanie odwołań

End Sub

Private Sub X_ItemRemoved(ByVal Reference As VBIDE.Reference)

    ' W tym miejscu należy umieścić kod obsługujący usuwanie odwołań

End Sub


Właściwość Saved - przykład

W tym przykładzie wykorzystano właściwość Saved do zwrócenia wartości typu Boolean umożliwiającej stwierdzenie, czy określony projekt został zapisany w swojej aktualnej postaci.

Debug.Print Application.VBE.VBProjects(1).Saved


Właściwość SelectedVBComponent - przykład

W tym przykładzie wykorzystano właściwość SelectedVBComponent do zwrócenia zaznaczonego składnika.

Debug.Print Application.VBE.SelectedVBComponent.Name


Właściwość TopLine - przykład

W tym przykładzie wykorzystano właściwość TopLine do zwrócenia numeru pierwszego wiersza w określonym okienku kodu programu.

Debug.Print Application.VBE.CodePanes(3).TopLine


Właściwość Type - przykład

W tym przykładzie wykorzystano właściwość Type do zwrócenia wartości określającej typ danego elementu kolekcji VBComponents w danym projekcie. Zwrócona wartość jest liczbą odpowiadającą predefiniowanej stałej określającej typ obiektu składowego.

Debug.Print Application.VBE.VBProjects(1).VBComponents(1).Type


Właściwość Value - przykład

W tym przykładzie wykorzystano właściwość Value do zwrócenia wartości określonej właściwości elementu kolekcji VBComponents.

Debug.Print Application.VBE. _

ActiveVBProject.VBComponents(1). _

Properties("AcceptLabelsInFormulas").Value


Właściwość VBE - przykład

W tym przykładzie wykorzystano właściwości VBE i Name do zwrócenia nazwy aktywnego projektu.

Debug.Print Application.VBE.ActiveVBProject.Name


Właściwość Version - przykład

W tym przykładzie wykorzystano właściwość Version do zwrócenia numeru wersji aplikacji głównej.

Debug.Print Application.VBE.Version


Właściwość Visible - przykład

W tym przykładzie wykorzystano właściwość Visible do zwrócenia wartości typu Boolean umożliwiającej stwierdzenie, czy określone okno jest widoczne.

Debug.Print Application.VBE.Windows(9).Visible


Właściwość Window - przykład

W tym przykładzie wykorzystano właściwości Window i Caption do zwrócenia nazwy określonego okienka kodu programu.

Debug.Print Application.VBE.CodePanes(1).Window.Caption


Właściwość WindowState - przykład

W tym przykładzie wykorzystano właściwość WindowState do zwrócenia stanu na ekranie określonego okna. Zwrócona wartość jest liczbą odpowiadającą predefiniowanej stałej określającej stan okna.

Debug.Print Application.VBE.Windows(9).WindowState


CodeModule - obiekt (Model obiektów stosowany w Dodatkach VBA)
CodeModule - obiekt

Reprezentuje kod programu realizujący obsługę elementu, takiego jak formularz, klasa lub dokument.

Użycie

Obiekt CodeModule umożliwia modyfikację (tj. dodawanie, usuwanie lub edycję) kodu programu związanego z danym elementem.

Każdy element jest związany z jednym obiektem CodeModule. Z danym obiektem CodeModule może natomiast być związanych wiele okienek kodu programu.

Metody obiektu CodeModule umożliwiają odczyt informacji dotyczących tekstu kodu programu oraz manipulowanie nim z dokładnością do pojedynczych wierszy. Na przykład, za pomocą metody AddFromString można dodać tekst do modułu. Metoda AddFromString wstawia tekst bezpośrednio nad pierwszą procedurę danego modułu lub na końcu modułu, jeśli moduł nie zawiera żadnej procedury.

Aby zidentyfikować obiekt VBComponent, z którym związany jest dany moduł kodu programu, należy użyć właściwości Parent.


CommandBarEvents - obiekt (Model obiektów stosowany w Dodatkach VBA)
CommandBarEvents - obiekt

Obiekt zwracany przez właściwość CommandBarEvents. Obiekt CommandBarEvents wyzwala zdarzenie, gdy na pasku poleceń zostanie kliknięty formant.

Użycie

Obiekt CommandBarEvents zwracany jest przez właściwość CommandBarEvents obiektu Events. Na interfejsie zwróconego obiektu zdefiniowano tylko jedno zdarzenie: Clik. Obsługę tego zdarzenia można realizować za pomocą deklaracji obiektu WithEvents.


CommandBars - kolekcja (Model obiektów stosowany w Dodatkach VBA)
CommandBars - kolekcja

Zawiera wszystkie paski poleceń z danego projektu, włącznie z paskami poleceń realizującymi menu skrócone.

Użycie

Kolekcja CommandBars umożliwia dodawanie nowych pasków poleceń i formantów z poziomu dodatków lub wstawianie dodatkowych formantów do istniejących, wbudowanych pasków poleceń.


VBComponent - obiekt (Model obiektów stosowany w Dodatkach VBA)
VBComponent - obiekt

Reprezentuje należący do danego projektu element typu moduł klasy lub moduł standardowy.

Użycie

Obiektów typu VBComponent należy używać do uzyskania dostępu do modułu kodu programu związanego z danym elementem lub do zmiany właściwości tego elementu.

Aby określić typ elementu reprezentowanego przez dany obiekt VBComponent, należy użyć właściwości Type. Aby zidentyfikować kolekcję, do której należy element, trzeba użyć właściwości Collection.


VBComponents - kolekcja (Model obiektów stosowany w Dodatkach VBA)
VBComponents - kolekcja

Reprezentuje wszystkie elementy należące do danego projektu.

Użycie

Za pomocą kolekcji VBComponents można dodawać lub usuwać elementy projektu, a także uzyskiwać dostęp do poszczególnych elementów. Elementem może być formularz, moduł lub klasa. Kolekcja VBComponents jest kolekcją standardową, która może być używana w instrukcji For Each.

Aby zidentyfikować projekt, z którego pochodzi dana kolekcja VBComponents, można użyć właściwości Parent.

W języku Visual Basic for Applications można za pomocą metody Import dodać do projektu element zapisany w pliku.


CodePane - obiekt (Model obiektów stosowany w Dodatkach VBA)
CodePane - obiekt

Reprezentuje okienko kodu programu.

Użycie

Obiekt CodePane służy do sterowania wyświetlaniem tekstu lub jego fragmentu w okienku kodu programu.

Metoda Show służy do wyświetlania określonego okienka kodu programu. Za pomocą metody SetSelection można ustawić w okienku kodu programu zaznaczenie, a za pomocą metody GetSelection można w tym okienku zlokalizować zaznaczenie.


CodePanes - kolekcja (Model obiektów stosowany w Dodatkach VBA)
CodePanes - kolekcja

Zawiera wszystkie aktywne okienka kodu programu obiektu VBE.

Użycie

Poprzez kolekcję CodePanes można uzyskać dostęp do wszystkich otwartych okienek kodu programu danego projektu.

Aby określić liczbę aktywnych okienek kodu programu wchodzących w skład kolekcji, należy użyć właściwości Count.


Events - obiekt (Model obiektów stosowany w Dodatkach VBA)
Events - obiekt

Udostępnia właściwości, które umożliwiają powiązanie dodatków ze wszystkimi zdarzeniami występującymi w środowisku Visual Basic for Applications.

Użycie

Obiekt Events udostępnia właściwości, które zwracają obiekt źródłowy zdarzenia. Właściwości te służą do zwracania obiektów generujących zdarzenia dostarczające informacji o zmianach w środowisku Visual Basic for Applications.

Właściwości obiektu Events zwracają obiekty o typie wyznaczonym przez nazwę użytej właściwości. Na przykład, właściwość CommandBarEvents zwraca obiekt CommandBarEvents.


LinkedWindows - kolekcja (Model obiektów stosowany w Dodatkach VBA)
LinkedWindows - kolekcja

Zawiera wszystkie okna połączone danej ramki okien połączonych.

Użycie

Kolekcja LinkedWindows służy w środowisku projektowania do zmiany stanu okna zadokowanego lub okna połączonego danego okna.

Właściwość LinkedWindowFrame obiektu Window zwraca obiekt typu Window z prawidłową kolekcją LinkedWindows.

Ramki okien połączonych zawierają wszystkie okna, które mogą być zadokowane lub połączone. Do tego typu okien należą wszystkie okna oprócz okien kodu programu, okien projektanta, okna Przeglądarki obiektów i okna dialogowego Znajdź i zamień.

Jeśli wszystkie okienka danej ramki okien połączonych zostaną przeniesione do innego okna, to taka pozbawiona okien ramka jest niszczona. Jedynie usunięcie z okna głównego wszystkich okienek nie powoduje zniszczenia tego okna.

Aby sprawdzić lub odpowiednio ustawić widoczność okna, należy użyć właściwości Visible.

Aby dodać okno do aktualnie istniejącej kolekcji okien połączonych, należy użyć metody Add. Okno, będące okienkiem w jakiejś ramce okien połączonych może być także dodane do innej ramki okien połączonych. Aby usunąć okno z kolekcji okien aktualnie połączonych, należy użyć metody Remove; usunięte okno traci wówczas cechy okna połączonego lub zadokowanego.

Kolekcja LinkedWindows jest używana do dokowania i uwalniania okien w ramce okna głównego.


Property - obiekt (Model obiektów stosowany w Dodatkach VBA)
Property - obiekt

Obiekty tego typu reprezentują właściwości innych obiektów wyświetlane dla dowolnego elementu w oknie Właściwości.

Użycie

Właściwość Value konkretnego obiektu Property służy do odczytu lub ustawiania wartości reprezentowanej przez niego właściwości danego elementu.

Każdy element posiada co najmniej właściwość Name. Aby odczytać lub ustawić wartość konkretnej właściwości, należy użyć właściwości Value odpowiadającego jej obiektu Property. Właściwość Value zwraca wartość typu Variant, która może odpowiadać dowolnemu typowi danych. Jeśli zwrócony zostanie obiekt, właściwość Value udostępnia również kolekcję Properties zawierającą obiekty Property, z których każdy opisuje oddzielną właściwość zwróconego obiektu. Dowolny obiekt Property można wydobyć ze zwróconej kolekcji Properties, stosując metodę Item.

Jeśli wartość zwracana przez obiekt Property jest obiektem, to ustawianie nowej wartości obiektu Property musi odbywać się za pomocą właściwości Object.


Properties - kolekcja (Model obiektów stosowany w Dodatkach VBA)
Properties - kolekcja

Reprezentuje właściwości danego obiektu.

Użycie

Kolekcja Properties udostępnia wszystkie właściwości wyświetlane w oknie Właściwości. Każdej właściwości ukazującej się w oknie Właściwości odpowiada konkretny obiekt kolekcji Properties.


Reference - obiekt (Model obiektów stosowany w Dodatkach VBA)
Reference - obiekt

Reprezentuje odwołanie do biblioteki typów lub do projektu.

Użycie

Obiekt Reference służy do sprawdzenia, czy dane odwołanie jest nadal prawidłowe.

Właściwość IsBroken zwraca wartość True, jeśli dane odwołanie przestało być prawidłowe. Właściwość BuiltIn zwraca wartość True, jeśli dane odwołanie jest odwołaniem domyślnym, które nie może być przeniesione lub usunięte. Aby sprawdzić, czy odwołanie, które chcemy ustawić lub usunąć, jest właściwym odwołaniem, należy posłużyć się właściwością Name.


References - kolekcja (Model obiektów stosowany w Dodatkach VBA)
References - kolekcja

Reprezentuje zbiór odwołań zdefiniowanych w danym projekcie.

Użycie

Za pomocą kolekcji References można dodawać lub usuwać odwołania. Kolekcja References jest to zbiór tych samych elementów, które są wybierane za pomocą okna dialogowego Odwołania.


ReferencesEvents - obiekt (Model obiektów stosowany w Dodatkach VBA)
ReferencesEvents - obiekt

Zwracany przez właściwość ReferencesEvents.

Użycie

Obiekt ReferencesEvents generuje zdarzenia sygnalizujące dodanie lub usunięcie odwołania w projekcie. Zdarzenie ItemAdded jest generowane po dodaniu odwołania do projektu. Zdarzenie ItemRemoved jest generowane po usunięciu odwołania z projektu.


VBE - obiekt (Model obiektów stosowany w Dodatkach VBA)
VBE - obiekt

Jest to obiekt nadrzędny zawierający wszystkie inne obiekty i kolekcje reprezentowane w środowisku Visual Basic for Applications.

Użycie

Dostęp do obiektów zawartych w obiekcie VBE umożliwiają następujące kolekcje:

•	Kolekcja VBProjects umożliwia dostęp do kolekcji projektów.

•	Kolekcja Windows umożliwia dostęp do kolekcji okien.

•	Kolekcja CodePanes umożliwia dostęp do kolekcji okienek kodu programu.

•	Kolekcja CommandBars umożliwia dostęp do kolekcji pasków poleceń.

Obiekt Events udostępnia właściwości, które umożliwiają powiązanie dodatków ze wszystkimi zdarzeniami występującymi w środowisku Visual Basic for Applications. Właściwości obiektu Events zwracają obiekty o typie wyznaczonym przez nazwę użytej właściwości. Na przykład, właściwość CommandBarEvents zwraca obiekt CommandBarEvents.

Aby zidentyfikować element aktywny, należy użyć właściwości SelectedVBComponent. Elementem aktywnym jest element, na którym są w danym momencie wykonywane działania w oknie Projekt. Jeśli nie jest to element, właściwość selectedVBComponent zwraca wartość Nothing.

Uwaga   Wszystkie obiekty w tym modelu obiektów mają właściwość VBE, która wskazuje na obiekt VBE.


VBProject - obiekt (Model obiektów stosowany w Dodatkach VBA)
VBProject - obiekt

Reprezentuje projekt.

Użycie

Obiekt VBProject służy do ustawiania właściwości projektu, uzyskiwania dostępu do kolekcji VBComponents i do kolekcji References.


VBProjects - kolekcja (Model obiektów stosowany w Dodatkach VBA)
VBProjects - kolekcja

Reprezentuje wszystkie projekty otwarte w danym środowisku projektowania.

Użycie

Kolekcja VBProjects służy do uzyskiwania dostępu do poszczególnych projektów danej instancji środowiska projektowego. Kolekcja VBProjects jest kolekcją standardową, która może być użyta w instrukcji For Each.


Window - obiekt (Model obiektów stosowany w Dodatkach VBA)
Window - obiekt

Reprezentuje okno w środowisku projektowania.

Użycie

Obiekt Window umożliwia wyświetlanie, ukrywanie lub umieszczanie okna w określonym miejscu.

Do zamknięcia okna umieszczonego w kolekcji Windows służy metoda Close. Efekt działania metody Close zależy od rodzaju okna w sposób następujący:

Okno	Efekt działania metody Close
Okno kodu programu	Okno zostaje usunięte z kolekcji Windows.
Projektant	Okno zostaje usunięte z kolekcji Windows.
Obiekty Window typu ramka okien połączonych	Okna tracą cechy okien połączonych i stają się oknami samodzielnymi.
Uwaga   Stosowanie metody Close do okien kodu programu lub okien projektanta powoduje ich zamknięcie. Ustawienie właściwości Visible na wartość False powoduje ukrycie okna, ale nie zamyka go. Stosowanie metody Close do okien będących stałymi elementami środowiska projektowego, takich jak okno Projekt lub okno Właściwości, ma taki sam skutek, jak przypisanie ich właściwości Visible wartości False.

Metoda SetFocus służy do ustawiania fokusa na określonym oknie.

Właściwość Visible służy do odczytania lub ustawienia statusu widoczności okna.

Do określenia typu okna, które aktualnie podlega działaniu, służy właściwość Type. Jeśli istnieje więcej okien tego samego typu, na przykład kilka okien projektanta, to do ustalenia, które z nich podlega działaniu można użyć właściwości Caption. Okno, z którym chcemy działać, można także odnaleźć, wykorzystując właściwości DesignerWindow obiektu VBComponent lub przy użyciu właściwości Window obiektu CodePane.


Windows - kolekcja (Model obiektów stosowany w Dodatkach VBA)
Windows - kolekcja

Zawiera wszystkie otwarte lub stałe okna środowiska.

Użycie

Za pomocą kolekcji Windows można uzyskać dostęp do obiektów typu Window.

Kolekcja Windows składa się ze stałego zbioru okien takich jak okno Projekt czy okno Właściwości, które znajdują się w tej kolekcji zawsze, i ze zbioru okien reprezentujących wszystkie okna kodu programu i okna projektanta. Otwarcie okna kodu programu lub okna projektanta oznacza dodanie nowego elementu do kolekcji Windows. Zamknięcie okna kodu programu lub okna projektanta oznacza usunięcie elementu z kolekcji Windows. Zamknięcie okna będącego stałym elementem środowiska projektowania nie powoduje usunięcia odpowiadającego mu obiektu z kolekcji; okno staje się jedynie niewidoczne.