VBA > Opis obiektów niebiznesowych > Document > Metody obiektu Document

Metody obiektu Document

Save

Zapisuje dokument (projekt) pod bieżącą nazwą. Jeśli projekt jest nowoutworzony i nie był dotychczas zapisany – zostanie wyświetlony dialog do zapisu pliku.

CreateAmControl

Metoda ta tworzy control danego typu w wyspecyfikowanym panelu okna.

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

PaneNo

Variant

VARIANT

Opcjonalny

Numer panela, w którym ma zostać utworzona kontrolka. Wartość domyślna – panel nr. 1.

Dane wyjściowe

Nazwa	Typ VBA	Typ Tlb	Opis
Wartość zwracana	Object	LPDISPATCH *	Zwracany jest obiekt stworzonej kontrolki.

DestroyAmControl

Metoda ta usuwa kontrolkę z wyspecyfikowanym panelu okna.

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

PaneNo

Variant

VARIANT

Opcjonalny

Numer panela w którym ma zostać usunięta kontrolka. Wartość domyślna – panel nr. 1.

CloseDoc

Zamyka dokument i okno.

Dane wejściowe

Nazwa	Typ VBA	Typ Tlb	Opis
Force	Boolean	VARIANT_BOOL	Wartość True wymusza zamknięcie dokumentu bez pytania o to czy dokument był zmodyfikowany

SetEraseBkgnd

Metoda ta "zastępuje" funkcjonalnie trzy property odnoszące się do poszczególnych paneli.

Jeżeli kontrolki dostosowują się do pełnego rozmiaru okna i same wypełniają zawartość okna poprawnie, należy ustawić False, w przeciwnym przypadku będzie występował efekt mrugania.

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

Erase

Boolean

VARIANT_BOOL

Jeśli parametr ma wartość "True", tło będzie automatycznie czyszczone. (Normalnie kontrolka wypełnia cały panel i nie ma potrzeby, aby tło było czyszczone. W przypadku gdy nie ma kontrolki w oknie – zawsze jest czyszczone, niezależnie od ustawienia. Niektóre kontrolki mogą jednak mieć stały rozmiar i nie reagować na zmianę rozmiaru.)

PaneNo

Variant

[in] VARIANT

Opcjonalny

Numer panela, w którym ma zostać ustawiony tryb czyszczenia tła (jeśli parametr jest nieustawiony – przyjęty domyślnie jest panel nr 1)

GetEraseBkgnd

Metoda ta pobiera informację na temat. czyszczenia tła w poszczególnych panelach.

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

PaneNo

Variant

VARIANT

Opcjonalny

Numer panela z którego ma zostać pobrana informacja na temat czyszczenia tła. Jeżeli parametr jest nieustawiony – domyślnie – panel nr 1.

Dane wyjściowe

Nazwa	Typ VBA	Typ Tlb	Opis
Wartość zwracana	Boolean	VARIANT_BOOL *	True jeżeli tło jest automatycznie czyszczone.

CreateAmControlOther

Metoda ta pozwala utworzyć dowolne kontrolki ocx, jeśli są zarejestrowane w systemie i posiadają ProgID. W przeciwieństwie do GUID ProgID nie gwarantuje 100% unikalności, ale jest szeroko stosowany i w praktyce unikalny. Metoda ta jest programowym substytutem wybierania kontrolki w panelu po użyciu "Other" w oknie właściwości (wówczas wyświetla się dialog z dostępnymi kontrolkami).

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

ProgID

String

BSTR

ProgID kontrolki która ma być utworzona w panelu okna. ProgID jest zrozumiałym dla człowieka odpowiednikiem GUID. Np. dla kalendarza z MXGrid: "MXGRID.CalendarCtrl.1"

Pane

Variant

VARIANT

Opcjonalny

Numer panelu w którym ma zostać umieszczona kontrolka (domyślnie panel nr 1).

Dane wyjściowe

Nazwa	Typ VBA	Typ Tlb	Opis
Wartość zwracana	Object	LPDISPATCH *	Zwracany jest obiekt kontrolki która została utworzona.

SetPaneSize

Okno "sbc" ma możliwość zamrażania i ustawiania procentowego rozmiaru dla poszczególnych paneli w oknie. (Tryb pracy ustawia metoda SetPaneSizeType lub dla poszczególnych paneli property: PaneSizeType1,...) Metoda SetPaneSize pozwala programowo ustawić rozmiar okna, nie zmienia trybu pracy. Przykład: SetPaneSize(1,,,25,True) ustawia rozmiar panela nr 1 w pionie na 25% aktualnego rozmiaru okna, nie zmieniając ustawień w poziomie.

Dane wejściowe

Nazwa	Typ VBA	Typ Tlb	Opis
Pane	Long	long	Numer panela którego wielkość chcemy ustawić.
CX	Variant	VARIANT	Opcjonalny Rozmiar panela w poziomie (jeżeli parametr jest pominięty – nie ustawiamy tego rozmiaru). W zależności od parametru XPercent wyrażony jest w pikselach, lub wyraża procentowy udział panela w rozmiarze całego okna (wówczas przyjmuje wartości od 0 do 100)
XPercent	Variant	VARIANT	Jeżeli parametr ma wartość True – rozmiar CX traktowany jest jako procentowy udział w rozmiarze całego okna. Jeżeli parametr nie jest ustawiony – domyślnie traktowany jest jak False.
CY	Variant	VARIANT	Opcjonalny Analogicznie jak CX – dla rozmiaru panela w pionie.
Ypercent	Variant	VARIANT	Opcjonalny Analogicznie jak YPercent – dla CY.
PaneNo	Variant	VARIANT	Opcjonalny Numer panelu w którym ma zostać umieszczona kontrolka.

GetPanelSize

Metoda ta pozwala pobrać aktualny rozmiar poszczególnych paneli.

Dane wejściowe

Nazwa	Typ VBA	Typ Tlb	Opis
Pane	Long	long	Numer panela, z którego ma zostać pobrana informacja o rozmiarze

Dane wyjściowe

Nazwa

Typ VBA

Typ Tlb

Opis

CX

Long

long *

Aktualny rozmiar (w pikselach) w poziomie.

CY

Long

long *

Aktualny rozmiar (w pikselach) w pionie.

SetPaneSizeType

Metoda ta zastępuje funkcjonalnie ustawianie property PaneSizeType1, 2,3.

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

PaneNo

Long

long

Numer panela w którym ma zostać ustawiony tryb zachowania rozmiaru

SizeType

AmPaneSizeType

Tryb zachowania rozmiaru panela.

GetPaneSizeType

Metoda ta zastępuje funkcjonalnie pobieranie ustawień z property PaneSizeType1, 2,3.

Dane wejściowe

Nazwa	Typ VBA	Typ Tlb	Opis
PaneNo	Long	long	Numer panela, z którego ma zostać pobrana informacja o typie rozmiaru.

Dane wyjściowe

Nazwa

Typ VBA

Typ Tlb

Opis

Wartość zwracana

AmPaneSizeType

Parametr zwraca tryb zachowania rozmiaru panela.

BeginLink

Polecenie otwiera okno serwera i nawiązuje z nim połączenie wymiany danych.

Łączenie okien VBA z innymi oknami

Dane wejściowe

Nazwa	Typ VBA	Typ Tlb	Opis
LinkType	Variant	VARIANT	Identyfikator predefiniowanego połączenia lub tekstowa nazwa okna serwera.

Dane wyjściowe

Nazwa

Typ VBA

Typ Tlb

Opis

Wartość zwracana

Boolean

VARIANT_BOOL *

True – nawiązano połączenie

False – nie nawiązano połączenia

UseLink

Polecenie powoduje przesłanie danych zwrotnych z okna serwera do okna klienta oraz zamkniecie połączenia między oknami.

Łączenie okien VBA z innymi oknami

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

Wartość zwracana

Boolean

VARIANT_BOOL *

Zawsze True

EndLink

Funkcja umożliwia jawne przerwanie utworzonego wcześniej połączenia między oknami, bez zwracania danych z serwera do klienta.

Łączenie okien VBA z innymi oknami

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

Wartość zwracana

Boolean

VARIANT_BOOL

Określa rodzaj połączenia, które należy przerwać:

True – połączenie w którym dane okno jest klientem

False – połączenie w którym dane okno jest serwerem

BreakLink

Parametry:

Client

Boolean

VARIANT_BOOL

CommandDoc

Analogicznie jak PropertyDoc metoda do ogólnego zastosowania. Głównym powodem powstania jest chęć zredukowania liczby metod w interfejsie oraz umożliwienie w przyszłości dodawania pewnej funkcjonalności bez konieczności zmiany interfejsu. Parametr "Index" jest obowiązkowy i to on decyduje o faktycznym przeznaczeniu metody. W zależności od wartości tego parametru wykorzystywane są pozostałe parametry oraz zwracany jest jakiś typ VARIANT'a.

Dane wejściowe

Nazwa	Typ VBA	Typ Tlb	Opis
Index	Variant	VARIANT	Index dla metody, faktycznie decydujący o wykonywanym działaniu (analogicznie jak message w pętli komunikatów)
Par1	Variant	VARIANT	Opcjonalny parametr, znaczenie określa Index
Par2	Variant	VARIANT	Opcjonalny parametr, znaczenie określa Index
Par3	Variant	VARIANT	Opcjonalny parametr, znaczenie określa Index
Par4	Variant	VARIANT	Opcjonalny parametr, znaczenie określa Index

Dane wyjściowe

Nazwa

Typ VBA

Typ Tlb

Opis

Wartość zwracana

VARIANT*

Znaczenie określa Index

SaveAs

Metoda ta pozwala zapisać plik projektu pod nową nazwą.

Dane wejściowe

Nazwa

Typ VBA

Typ Tlb

Opis

FileName

Variant (String)

VARIANT

Opcjonalna

Nazwa pliku (wraz ze ścieżką) pod którą plik ma zostać zapamiętany. Jeżeli string będzie pusty lub parametr nie zostanie podany – zostanie wyświetlony dialog wyboru nazwy pliku.