Pyramid.XmlObject är en klass som möjliggör hanterande av XML-dokument i betakod. Ett Pyramid.XmlObject representerar ett XML-dokument och har inbyggd funktionalitet för navigering i dokumentet. Navigering sker mellan elementnoder. Om dokumentet inte är tomt, så finns det alltid ett aktuellt element som man arbetar mot. Ett objekt skapas med
object oXml
create_object("Pyramid.XmlObject") -> oXml
ifl not ok
Exception("Kan inte skapa ett Pyramid.XmlObject.")
endifl
När objektet är färdiganvänt måste det frigöras med
delete_object(oXml)
Pyramid.XmlObject installeras med InstallXmlObject.exe i xml-mappen. Installationen medför att XmlObject.dll i samma mapp kopieras till GACen och registreras i datorns systemregister.
Läser in ett XML-dokument från en fil. Om läsningen lyckades returneras sant. Vid fel retuneras falskt och felmeddelandet ges av ErrorMessage(). Om felet berodde på att XML-filen inte är välformad så ger ErrorLineNumber() och ErrorLinePosition() var i filen som det är fel.
Läser in ett XML-dokument från en sträng. Om läsningen lyckades returneras sant. Vid fel returneras falskt och felmeddelandet ges av ErrorMessage(). Funktionerna ErrorLineNumber() och ErrorLinePosition() ger då var i strängen som XML-koden inte är korrekt.
Sparar XML-dokumentet till en fil med den kodning som anges i encoding. Kodningen kan lämnas tom och då kommer UTF-8 att användas. Om sparandet lyckades returneras sant, annars falskt och ett felmeddelande kan hämtas med ErrorMessage().
Tömmer dokumentet.
Skapar ett rotelement med angivet namn och namnrum. Det nya rotelementet blir aktuellt element.
Ger en XML-sträng för hela dokumentet. Kodningen i en sträng är alltid ISO-8859-1.
Utför en XSL-transformation på dokumentet. XSLT-filen hämtas från stylesheetFilename. Resultatet av transformationen sparas till outputFilename. Om allting gick bra returneras sant. Om något fel uppstod returneras falskt och felmeddelandet ges av ErrorMessage(). Om felet berodde på att XSLT-filen inte är välformad så ger ErrorLineNumber() och ErrorLinePosition() var i filen som det är fel.
Textinnehållet i aktuellt element. Textinnehållet är sammanslagningen av alla textnoder tillhörande aktuellt element och alla dess barn, barnbarn osv. Kan även tilldelas, i så fall ersätts alla eventuella barnnoder till aktuellt element med endast en textnod.
Namnet för aktuellt element. Detta inkluderar eventuellt prefix och är samma som tagg-namnet för aktuellt element.
Namnet utan eventuellt prefix för aktuellt element.
Namnrummet som aktuellt element tillhör.
Prefixet för aktuellt element. Kan tilldelas.
Ger en XML-sträng för den aktuella elementnoden och alla dess barn.
Ger värdet för attributet med angivet namn. Om attributet inte existerar returneras en tom sträng.
Sätter värdet för angivet attribut med ett namnrum. Attributnamnet kan innehålla ett prefix.
Sätter värdet för angivet attribut.
Ger sant om aktuellt element har ett attribut med angivet namn, annars returneras falskt.
Tar bort angivet attribut från aktuellt element.
Antalet attribut som aktuellt element har.
Ger namnet för attributet med givet index för aktuellt element. Första attributet har index 0 och sista har index lika med antal attribut minus ett.
Ger värdet för attributet med givet index för aktuellt element. Första attributet har index 0 och sista har index lika med antal attribut minus ett.
Utför en XPath-sökning utgående från aktuellt element. Namnrummet för det aktuella elementet kopplas till angivet prefix. Om ett element hittas returneras sant och det funna elementet blir nytt aktuellt element. Om inget element hittades returneras falskt och aktuellt element förblir samma.
Flyttar till sist skapade element.
Flyttar till aktuellt elements barnelement med angivet namn. Om det finns flera barnelement med angivet namn, så väljs det första. Returnerar sant om det gick att flytta till ett barnelement med givet namn, annars returneras falskt och aktuellt element förblir samma.
Flyttar till aktuellt elements nästa syskonelement med angivet namn. Om det finns flera efterföljande syskonelement med angivet namn, så väljs första. Returnerar sant om det gick att flytta till ett efterföljande syskonelement med givet namn, annars returneras falskt och aktuellt element förblir samma.
Antal barnelement till aktuellt element.
Flyttar till aktuellt elements första barn. Returnerar sant om det fanns ett barnelement att flytta till, annars falskt och aktuellt element förblir samma.
Flyttar till aktuellt elements sista barn. Returnerar sant om det fanns ett barnelement att flytta till, annars falskt och aktuellt element förblir samma.
Flyttar till aktuellt elements nästa syskonelement. Returnerar sant om det fanns ett efterföljande syskonelement att flytta till, annars falskt och aktuellt element förblir samma.
Flyttar till aktuellt elements föregående syskonelement. Returnerar sant om det fanns ett föregående syskonelement att flytta till, annars falskt och aktuellt element förblir samma.
Flyttar till aktuellt elements föräldraelement. Returnerar sant om det fanns ett föräldraelement att flytta till, annars falskt och aktuellt element förblir samma.
Flyttar till dokumentets rotelelement. Returnerar sant om det fanns ett rotelement att flytta till, annars falskt och aktuellt element förblir samma, dvs. ogiltigt eftersom dokumentet i så fall inte inehåller några element.
Ger sant om aktuellt element har ett eller flera barnelement.
Ger sant om aktuellt element har en efterföljande elementnod.
Ger sant om aktuellt element har en föregående elementnod.
Ger sant om dokumentet har ett rotelement.
Sparar aktuell position som ett bokmärke med angivet namn.
Flyttar till elementet som har sparats undan med namngivet bokmärke. Returnerar sant om bokmärket fanns, annars falskt och aktuellt element förblir samma.
Sparar aktuell position på en stack.
Flyttar till det element som är överst på stacken och tar bort elementet från stacken. Returnerar sant om det fanns ett element på stacken att flytta till, annars falskt och aktuellt element förblir samma.
Flyttar till det element som är överst på stacken, men låter elementet ligga kvar på stacken. Returnerar sant om det finns ett eleement på stacken, annars falskt och aktuellt element förblir samma.
Skapar ett nytt barnelement till aktuellt element. Det nya barnelementet hamnar efter övriga barnelement. Elementet kommer att tillhöra samma namnrum som föräldraelementet. Returnerar sant om det gick att skapa ett barnelement, annars falskt.
bool AppendChildWithNamespace(string name, string namespaceURI, string text)
Skapar ett nytt barnelement till aktuellt element. Det nya barnelementet hamnar efter övriga barnelement. Elementet kommer att tillhöra det namnrum som anges i namepspaceURI. Returnerar sant om det gick att skapa ett barnelement, annars falskt.
Skapar ett nytt barnelement till aktuellt element. Det nya barnelementet hamnar före övriga barnelement. Returnerar sant om det gick att skapa ett barnelement, annars falskt.
Skapar ett nytt barnelement till aktuellt element och placerar det före barnelementet med index child. Returnerar sant om det gick att skapa ett barnelement, annars falskt.
Skapar ett nytt barnelement till aktuellt element och placerar det efter barnelementet med index child. Returnerar sant om det gick att skapa ett barnelement, annars falskt.
Skapar ett nytt element som sykonelelement före aktuellt element. Returnerar sant om det gick att skapa ett syskonelement, annars falskt.
Skapar ett nytt element som syskonelement efter aktuellt element. Returnerar sant om det gick att skapa ett syskonelement, annars falskt.
Tar bort alla attribut och barnelement till aktuellt element.
Tar bort barnelementet med angivet index.
Raderar aktuellt element. Nytt aktuellt element blir elementets föräldraelement. Om elementet är rotelementet så blir aktuellt element ogilitigt.
Skapar ett SOAP 1.1-envelope omkring dokumentet. Nuvarande rotelementet blir barnelement till Body-elementet och nytt rotelement blir Envelope-elementet.
Tar bort ett SOAP 1.1-envelope kring dokumentet. Nytt rotelement blir Body-elementets barnelement.
Gör ett anrop till angiven URL och skickar med detta objekts XML-dokument. Från svaret skapas ett nytt XmlObject som returneras. Om något gick fel returneras null och felmeddelandet ges av ErrorMessage(). För att testa att ett objekt returnerades använder man betainstruktionen is_valid_object.
Gör ett anrop till angiven URL och skickar med detta objekts XML-dokument. Autenticiering görs med username och password. De flesta autenticieringsmekanismer stöds: basic, digest m. fl. Från svaret skapas ett nytt XmlObject som returneras. Om något gick fel returneras null och felmeddelandet ges av ErrorMessage(). För att testa att ett objekt returnerades använder man betainstruktionen is_valid_object.
Gör ett anrop till angiven URL och skickar med detta objekts XML-dokument. soapaction-argumentet anger det värde som kommer skickas med som SOAPAction i http-headern. Autenticiering görs med username och password. De flesta autenticieringsmekanismer stöds: basic, digest m. fl. Från svaret skapas ett nytt XmlObject som returneras. Om något gick fel returneras null och felmeddelandet ges av ErrorMessage(). För att testa att ett objekt returnerades använder man betainstruktionen is_valid_object.
Felmeddelande för senast inträffade fel.
Ger det radnummer där XML-dokumentet inte är välformat om det inte gick att läsa med Load() eller LoadXml(). Även aktuellt radnummer om Transform() misslyckades pga. att XSLT-filen inte var välformad.
Ger den kolumn där XML-dokumentet inte är välformat om det inte gick att läsa med Load() eller LoadXml(). Även aktuell kolumn om Transform() misslyckades pga. att XSLT-filen inte var välformad.
En sträng med information om dll:n från vilken objektet har skapats. Bl.a. versionsnummer och sökväg.