|
Handel - Objekty predefiniowane > XMLFile - obiekt predefiniowany | | Drukuj |
Jest to definicja obiektu przeznaczonego do tworzenie prostych dokumentów w formacie XML. Obiekt nie zapewnia kontroli poprawności tworzonego dokumentu. Zdefiniowany został zbiór metod tworzących interfejs obiektu. Definicja interfejsu przedstawiona jest poniżej.
Atrybuty
Brak.
Metody
Przerywa tworzenie dokumentu XML.Kasuje wcześniej stworzony plik.
Składnia Abort( )
Argumenty Brak. |
Tworzy atrybut i nadaje mu wartość. Atrybut ten będzie przypisany pierwszemu elementowi zdefiniowanemu po definicji atrybutu. Brak argumentu wartosc jest traktowana jako pusty string.
Składnia Attribute (String nazwa [,Typ wartosc])
Argumenty |
Kasuje odpowiednie flagi obiektu wykorzystywane w procesie tworzenia dokumentu XML. Obecnie dostępny jest następujący układ flag: 0x01 – określający sposób traktowania atrybutów elementów pustych. Skasowanie flag oznacza, iż atrybuty elementów pustych nie będą wstawiane do dokumentu.
Składnia ClearFlags (Int mask)
Argumenty
|
Kończy proces tworzenia dokumentu XML. Zamyka i zapisuje zawartość aktualnie przetwarzanego pliku.
Składnia Close ( )
Argumenty Brak. |
Tworzy element i nadaje mu wartość. Tworzy zarówno znacznik otwierający jak i zamykający. Brak argumentu wartosc jest traktowana jako pusty string i tworzy element pusty.
Składnia Element (String nazwa [,Typ wartosc])
Argumenty |
Ustawia standard kodowania w którym tworzony jest dokument. Domyślnym standardem jest UTF-8. Aby nazwa standardu była zmieniona w deklaracji należy ją ustawić przed wywołaniem metody Open.
Składnia Encoding (String std)
Argumenty
|
Tworzy znacznik zamykający elementu nazwa.
Składnia EndElement (String nazwa)
Argumenty
|
Określa sposób formatowania dokumentu.
Składnia Indent (Int wart)
Argumenty
|
Otwiera plik dokumentu XML do edycji (ewentualnie tworzy plik, gdy nie istnieje). Poprzednia zawartość pliku jest kasowana.
Składnia Open (String plik)
Argumenty
|
Ustawia odpowiednie flagi obiektu wykorzystywane w procesie tworzenia dokumentu XML. Obecnie dostępny jest następujący układ flag: 0x01 – określający sposób traktowania atrybutów elementów pustych. Ustawia flag oznacza, iż atrybuty elementów pustych będą wstawiane do dokumentu.
Składnia SetFlags (Int mask)
Argumenty
|
Ustawia wartość atrybutu standalone. Aby wartość była zmieniona w deklaracji należy ją ustawić przed wywołaniem metody Open.
Składnia StandAlone (Int wart)
Argumenty
|
Tworzy znacznik otwierający elementu nazwa. Wewnątrz znacznika mogą wystąpić atrybuty wcześniej zadeklarowane za pomocą metody Attribute. Poprawny dokument XML zawiera dokładnie jeden element główny. Większa ilość elementów może wystąpić tylko wewnątrz jakiegoś innego elementu. W szczególności wszystkie elementy dokumentu są zawarte w elemencie głównym.
Składnia StartElement (String nazwa)
Argumenty
|
Wstawia argument wartosc jako tekst w miejscu wywołania. Wstawienie tekstu metodą Value poza zakresem jakiegokolwiek elementu sprawi, iż dokument nie będzie poprawny.
Składnia Value (Typ wartosc)
Argumenty |
wersję XML w której tworzony jest dokument. Aby numer wersji był zmieniony w deklaracji należy go ustawić przed wywołaniem metody Open.
Składnia Version (String wersja)
Argumenty
|
Ustalenie, czy tworzony dokument XML będzie zawierał na początku deklarację.
Składnia XMLDeclaration (Int wart)
Argumenty
|
