Dokumentation der XSLT Erweiterungen in cardo

Hinweis: Die Extension werden von cardo in den Modulen cardo.Puzzle und cardo.Button im Namespace eo:iduCore registriert.

Die mit "iduPdf" gekennzeichneten Erweiterungsfunktionen gehören zum Erweiterungsobjekt eo:iduPdf und sind nur für den PDF- Ausgabemodus vorgesehen.

Die mit "iduDocX" gekennzeichneten Erweiterungsfunktionen gehören zum Erweiterungsobjekt eo:iduDocX und sind nur für den DocX - Ausgabemodus vorgesehen.

<xsl:stylesheet version="1"
                                    xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
                                    xmlns:iduCore="eo:iduCore" xmlns:iduPdf="eo:iduPdf" xmlns:iduDocX="eo:iduDocX">
    <!-- your Code here -->
</xsl:stylesheet>        


AddLayerToLayerList, CleanupTempFilesInDispose, ConvertInfoTypeBBoxToIxrhBBox, ConvertWktToEWkt, CreateLegendImageByLayerName, CreateMapImage, DecodeLocalName, DistinctValues, FormatByteSize, FormatDateTime, FormatNumber, FormatPlainTextToHtml, GetArgumentValue, GetAvailableXsltArguments, GetCounter, GetGeomArea, GetGeomDistance, GetGeomLength, GetGeomPerimeter, GetMarkerSketchGraphicsFromGeom, GetMarkerSketchGraphicsFromMapReader, GetSketchGraphicsFromGeom, GetTicksFromDateTime, IncreaseCounter, InitCounter, InitCounter, InnerXml, IsRenderTargetDOCX, IsRenderTargetPDF, LastCreateMapResponse, LogMessages, MapCalculateBboxToBestScale, MapCreateSelLayer, MapModifyBBox, MapModifyBBox, MapModifyBBoxToBestScale, MapModifyBBoxToScale, MapModifyBBoxZoomToGeom, MapModifyBBoxZoomToGeomWithOffset, MapModifyLayerList, MapModifySetSketch, MapQueryReturnXmlDocument, ModifyMapQueryFilterValues, Now, ParseXml, ReformatXmlString, Replace, ResolveImageUrlToLocalFile, SelectNodesByXPathString, SelectSingleNodeByXPathString, SetCounter, SetForcePdfCompatibleURIs, StringJoin, StringSplit, ToLower, ToUpper, TransformGeom, AppendPdfDocumentFromCardoPuzzleDocument, AppendPdfDocumentFromFile, AppendPdfDocumentFromIkxStoredBlob, CreatePdfAttachmentFromBytes, CreatePdfAttachmentFromFile, CreatePdfAttachmentFromIkxStoredBlob, SetMargin, SetMargins, SetOrientation, SetPageSize, SetPageSizeByName, SetPdfDocumentProperties, SetPdfDocumentSecurity, SetPdfHeaderAndFooter, AppendDocumentFromIkxStoredBlob, AppendPdfDocumentFromCardoPuzzleDocument, CreateAttachmentFromFile, SetDocXHeaderAndFooter, SetMargin, SetMargins, SetOrientation, SetPageSize, SetPageSizeByName, AddLayerByTagsToLayerList, CreateLegendImageByLayerTag, GetCurrentApplicationRootUrl, GetFileIconByName, GetLayerListFromMyMap, GetLayerTag, GetLayerTitle, GetPuzzleDataByQPzlId, GetPuzzleDataForNode, GetVisibleLayerListFromView, IkxCheckEntityExists, IkxGetClassDescription, IkxGetClassLabel, IkxGetClassXml, IkxGetEntityDescription, IkxGetEntityGroupName, IkxGetEntityLabel, IkxGetEntitySortHint, IkxGetEntityTabName, IkxIsEntityMeaningSet, IkxIsStoreSelected, IkxRenderMimeTypeValueToHtml, IkxSelectIkxStore, IsAnonymous, IsUserIsInRole, UserDescription, UserName, XPathToNode

AddLayerToLayerList(XPathNodeIterator oldLayerListString layerNames)

Verfügbar in: eo:iduCore

Fügt Layer an eine bestehende LayerList an

Argumente

CleanupTempFilesInDispose(Boolean mode)

Verfügbar in: eo:iduCore

Aktiviert oder deaktiviert das Löschen temp. erstellter Dokumente nach dem Beenden der Aktion. Standardmäßig ist diese Funktion aktiviert.

Argumente

ConvertInfoTypeBBoxToIxrhBBox(XPathNodeIterator infoTypeBbox)

Verfügbar in: eo:iduCore

Konvertiert einen Extent aus dem Namespace http://schemas.webs.idu.de/iwan/informationTypes in einen Extent im Namespace http://schemas.webs.idu.de/iwan/iXRH. Z.B. für die Weiterverwendung des BoundingBox Typen aus dem Ergebnis der Methode MapCreateSelLayer

Argumente

ConvertWktToEWkt(String wktInt32 epsg)

Verfügbar in: eo:iduCore

Konvertiert anhand der übergebenen EPSG eine Geometrie im WKT-Format in eine EWKT-Geometrie (es handelt sich hier nicht um eine Transformation sondern lediglich um eine Zuweisung der richtigen EPSG)

Argumente

Rückgabe

String EWKT-Geometrie

CreateLegendImageByLayerName(String layerName)

Verfügbar in: eo:iduCore

Gibt die URL zum Legendenbild für eine Ebene, die zu übergeben ist, aus

Argumente

CreateMapImage(XPathNodeIterator node)

Verfügbar in: eo:iduCore

Erzeugt ein Kartenbild und gibt die Url zu dem erstellten Bild zurück.

Weitere Details zum Kartenbild können mittels LastCreateMapResponse abgerufen werden.

Der Parametersatz kann mit verschiedenen Methoden transformiert werden. In der Praxis wird das Element "Option" in einem Button-Plan eingesetzt und mit den ModifyMap** Methoden geändert.

Beispiel

            <img >
              <xsl:attribute name="src">
               <xsl:value-of select="cardoButton:CreateMapImage(
                 cardoButton:MapModifySetSketch(
                     cardoButton:MapModifyLayerList($imageProps,'L17'),
                     cardoButton:GetMarkerSketchGraphicsFromMapReader($filterProps,
                       'L17',
                       'red',
                       'FilledCircle',10,
                       'OBJECTID',12,
                       'LowerLeft',
                       'Black','Silver')
                       ),-1
                 )"/>
               </xsl:attribute>
            </img>
            

Achtung: Iwan arbeitet mit 80 dpi (bzw. 3200 PixelPerMeter) imageWidth und imageHeight werden als solche Iwan-Pixel interpretiert ein typisches Dokument hat aber eine Auflösung von 96 dpi (bzw. 3840 PixelPerMeter, das von Iwan generierte Bild wird also nur maßstäblich dargestellt, wenn es bei der Ausgabe auf 96 dpi skaliert wird

Argumente

DecodeLocalName(String localName)

Verfügbar in: eo:iduCore

Decodiert einen Elementnamen, der von einer Methode erstellt wurde, die diesen zuvor mit Decode umgewandelt hat. Z.B. als Ergebnis der Methode MapQueryReturnXmlDocument

Argumente

DistinctValues(XPathNodeIterator values)

Verfügbar in: eo:iduCore

Erstellt aus den String-Werten der Liste Value eine neue Liste der eindeutigen Werte.

Argumente

FormatByteSize(Int64 byteLength)

Verfügbar in: eo:iduCore

Gibt eine Zahl formatiert als Byte/MByte etc. zurück

Argumente

FormatDateTime(DateTime valueString formatStringBoolean useInvariantCultur)

Verfügbar in: eo:iduCore

Formatiert eine Datum in eine Zeichenkette, verwendet intern value.Format (wobei value = DateTime).

Argumente

FormatNumber(Decimal valueString formatStringBoolean useInvariantCultur)

Verfügbar in: eo:iduCore

Formatiert eine Zahl in eine Zeichenkette, verwendet Decimal.ToString (Achtung: Änderung, vorher String.Format!)

Argumente

FormatPlainTextToHtml(String valueBoolean escapeLinesString paragraphElementString emptyEl)

Verfügbar in: eo:iduCore

Konvertiert einen Plain-Text in X(html), wobei Umbrüche als Absätze dargestellt werden. Zurück kommt ein Text, der ohne output-escaping eingefügt werden kann.

Argumente

GetArgumentValue(String nameBoolean lookupInRequest)

Verfügbar in: eo:iduCore

Gibt einen Wert aus dem durch die Umgebung übergebenen Argumentenspeicher zurück. Wurde lookupInRequest -1 (true) übergeben, dann wird als Fallback im Http-Request nachgeschaut.

Argumente

GetAvailableXsltArguments()

Verfügbar in: eo:iduCore

Ermitteln der Namen aller verfügbaren Erweiterungsobjekt-Argumente.

Rückgabe

String: als XML serialisiertes Array von Argumentnamen

GetCounter(String key)

Verfügbar in: eo:iduCore

Gibt den aktuellen Wert des Zählers zurück.

Argumente

Rückgabe

Aktueller Wert des Zählers

GetGeomArea(String geomInAnyFormat)

Verfügbar in: eo:iduCore

Gibt den Umfang eines Polygons zurück

Argumente

Rückgabe

der Flächeninhalt der Fläche in Quadradtmetern - wenn es keine Fläche ist, wird 0 zurückgegeben

GetGeomDistance(String geomInAnyFormatAString geomInAnyFormatB)

Verfügbar in: eo:iduCore

Bestimmt den Abstand zwischen zwei Geometrien

Argumente

Rückgabe

der Abstand beider Geometrien

GetGeomLength(String geomInAnyFormat)

Verfügbar in: eo:iduCore

Gibt die Länge einer Linie zurück

Argumente

Rückgabe

die Länge der Linie in Metern - wenn es keine Linie ist, wird 0 zurückgegeben

GetGeomPerimeter(String geomInAnyFormat)

Verfügbar in: eo:iduCore

Gibt den Umfang eines Polygons zurück

Argumente

Rückgabe

der Umfang der Fläche in Metern - wenn es keine Fläche ist, wird 0 zurückgegeben

GetMarkerSketchGraphicsFromGeom(String geomInAnyFormatString markerColorString markerSymbolEnumInt32 markerSizeString labelTextInt32 fontSizeString fontAnchorString fontColorString fontBackgroundColor)

Verfügbar in: eo:iduCore

Erstellt Sketch-Elemente für jeden Centroid der Geom und gibt das sich ergebende JSON Dokument für die Übergabe an einen Parametersatz für eine Kartenanforderung zurück. Wird in Verbindung mit MapModifySetSketch genutzt.

Die Elemente werden via CenterPoints beschafft

Argumente

GetMarkerSketchGraphicsFromMapReader(XPathNodeIterator mapQueryElementString layerNameString markerColorString markerSymbolEnumInt32 markerSizeString labelColumnNameInt32 fontSizeString fontAnchorString fontColorString fontBackgroundColor)

Verfügbar in: eo:iduCore

Liest die Datensätze der Ebene mit dem übergebenen Filter aus. Erstellt Sketch-Elemente für jeden Datensatz und gibt das sich ergebende JSON Dokument für die Übergabe an einen Parametersatz für eine Kartenanforderung zurück. Wird in Verbindung mit MapModifySetSketch genutzt.

Die Geometrie wird via CenterPoints der betroffenen Datensätze beschaft.

Argumente

GetSketchGraphicsFromGeom(String geomInAnyFormatString borderColorInt32 borderWidthString fillColorInt32 fillAlpha)

Verfügbar in: eo:iduCore

Erstellt ein Sketch-Element aus der übergebenen Geometrie und gibt das sich ergebende JSON Dokument für die Übergabe an einen Parametersatz für eine Kartenanforderung zurück. Wird in Verbindung mit MapModifySetSketch genutzt.

Als Geometrien sind nur Flächen und Linien zulässig. Multiparts werden berücksichtigt.

Argumente

GetTicksFromDateTime(DateTime time)

Verfügbar in: eo:iduCore

Gibt die Tick's des übergebenen DateTime Objekt zurück.

Argumente

IncreaseCounter(String key)

Verfügbar in: eo:iduCore

erhöht den Zähler um 1.

Argumente

Rückgabe

Aktuellen Wert des Zählers nach der Operation

InitCounter(String key)

Verfügbar in: eo:iduCore

Legt einen neuen Zähler mit dem übergebenen Schlüssel an. Der Zähler wird mit 0 initialisiert.

Argumente

InitCounter(String keyInt32 value)

Verfügbar in: eo:iduCore

Legt einen neuen Zähler mit dem übergebenen Schlüssel an und initialisiert ihn mit dem übergebenen Wert.

Argumente

InnerXml(XPathNodeIterator node)

Verfügbar in: eo:iduCore

Gibt das Inner-Xml des Nodeset als Zeichenkette zurück

Argumente

Rückgabe

String: als String serialisertes XML

IsRenderTargetDOCX()

Verfügbar in: eo:iduCore

Gibt true zurück, wenn die aktuelle Erstellung primär für DOCX gedacht ist.

IsRenderTargetPDF()

Verfügbar in: eo:iduCore

Gibt true zurück, wenn die aktuelle Erstellung primär für PDF gedacht ist.

LastCreateMapResponse()

Verfügbar in: eo:iduCore

Gibt Informationen zu dem letzten mittels CreateMapImage erstellten Kartenbild zurück, z.B. Maßstab, Bildgröße etc.

Ausgabe

Beispiel

            <iXRH:ImageResponse imageWidth="500" 
            	imageHeight="500" 
            	imageSizeLargestEdge="500" 
            	mapScale="2570.33" 
            	contextType="MapImage" 
            	targetImageType="Png24" 
            	durationFromRequestToCompress="77" 
            	creationDurationMilliSeconds="105" 
            	imageState="Complete" 
            	xmlns:iXRH="http://schemas.webs.idu.de/iwan/iXRH">
            	<iXRH:BBox 
                       epsgCode="31469" 
            			xmin="5334296.16162" 
            			ymin="5705771.04547" 
            			xmax="5334697.77593" 
            			ymax="5706172.65978" />
            </iXRH:ImageResponse>
            

Zugriff

Beispiel

            <xsl:value-of select="iduCore:LastCreateMapResponse()/iXRH:ImageResponse/@mapScale"/>
            

LogMessages(Boolean mode)

Verfügbar in: eo:iduCore

Legt fest ob detailliertes Logging aktiviert/deaktiviert werden soll. Per Default ist das Logging deaktiviert.

Zurückgegeben wird der effektive Wert (es kann sein, dass die Umgebung keinen Logger breitstellt)

Argumente

MapCalculateBboxToBestScale(Double farToNearBalanceXPathNodeIterator extentNodeInt32 mapWidthInt32 mapHeightXPathNodeIterator scalesNode)

Verfügbar in: eo:iduCore

Passt einen Extent so an, dass er in einem der übergebenen Maßstäbe liegt. Passt der Extent in keinen Kartenausschnitt mit einem der gegebenen Maßstäbe hinein, wird der Eingangswert verwendet.

Beispiel

             <xsl:variable name="AdjustedBbox"
            	  select="ce:MapCalculateBboxToBestScale(
             	  0.75,
             	  ce:ConvertInfoTypeBBoxToIxrhBBox($selLayerNameAndguid/infoTypes:BoundingBox),
                   600,600,
                   '1000,1500,2000,2500')" />
            

Argumente

MapCreateSelLayer(XPathNodeIterator nodeString layerName)

Verfügbar in: eo:iduCore

Erstellt eine Selektionsebene und gibt einen SelRenderLayer_Type (Element IxrhSelLayerInfo) zurück.

Beispiel

            <ns:IxrhSelLayerInfo maxAgeSeconds="86400" sourceLayerName="L141" isSessionDepended="true" xmlns:ns="http://schemas.webs.idu.de/iwan/informationTypes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
             <ns:RecordCount>1</ns:RecordCount>
            <ns:Guid>e8acc523-3ea0-4528-b099-2002de47eaae</ns:Guid>
            <ns:BoundingBox epsg="31469">
            <ns:Min x="5334396.16162424" y="5705884.58376304" />
            <ns:Max x="5334597.77593064" y="5706059.12148559" />
            </ns:BoundingBox>
            </ns:IxrhSelLayerInfo>
            

Argumente

MapModifyBBox(XPathNodeIterator nodeDouble epsgCodeDouble xmaxDouble xminDouble ymaxInt32 ymin)

Verfügbar in: eo:iduCore

Ändert den Extent für den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. CreateMapImage

Argumente

MapModifyBBox(XPathNodeIterator nodeXPathNodeIterator bboxNode)

Verfügbar in: eo:iduCore

Ändert den Extent für den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. CreateMapImage

Argumente

MapModifyBBoxToBestScale(XPathNodeIterator nodeDouble farToNearBalanceXPathNodeIterator scalesNode)

Verfügbar in: eo:iduCore

Ändert den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. Passt den Kartenausschnitt so an, dass sich, bei der für das Kartenbild eingestellten Pixelgröße des Kartenbildes, einer der übergebenen Maßstäbe ergibt. Passt der Extent in keinem der Maßstäbe in das Bild, bleibt der Ausschnitt unverändert. CreateMapImage

Argumente

MapModifyBBoxToScale(XPathNodeIterator nodeDouble scale)

Verfügbar in: eo:iduCore

Ändert den Kartenausschnitt für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. Passt den Kartenausschnitt so an, dass sich, bei der für das Kartenbild eingestellten Pixelgröße des Kartenbildes, der übergebene Maßstab ergibt. Der Extent wird um das aktuelle zentrum vergrößert bzw. verkleinert. CreateMapImage

Argumente

MapModifyBBoxZoomToGeom(XPathNodeIterator nodeString geomInAnyFormatDouble minSize)

Verfügbar in: eo:iduCore

Ändert den Extent für den Kartenausschnitt in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. Zoomt dabei auf die übergebene Geometrie und erstellt ein Kartenbild, das mindestens die übergebenen Größe (Karteneinheiten) besitzt. CreateMapImage

Argumente

MapModifyBBoxZoomToGeomWithOffset(XPathNodeIterator nodeString geomInAnyFormatDouble offset)

Verfügbar in: eo:iduCore

Ändert den Extent für den Kartenausschnitt in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. Zoomt dabei auf die übergebene Geometrie und erstellt ein Kartenbild, das um die Geometrie den übergebenen Offset als "Rand" belässt

Argumente

MapModifyLayerList(XPathNodeIterator nodeXPathNodeIterator layerList)

Verfügbar in: eo:iduCore

Ändert die Ebenen-Liste in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. CreateMapImage

Argumente

MapModifySetSketch(XPathNodeIterator nodeString sketchJsonBoolean append)

Verfügbar in: eo:iduCore

Ändert die Ausgestaltungselemente (Overlays, die via Sketch-Grafik dargestellt werden) in einem Parametersatz für die Kartenerstellung und gibt das modifiziert "RenderMap" Element zurück. CreateMapImage

Argumente

MapQueryReturnXmlDocument(XPathNodeIterator queryNodeString layerName)

Verfügbar in: eo:iduCore

Führt eine Abfrage auf eine Ebene durch und gibt als Antwort eine Xml Dokument mit allen Zeilen zurück. Das Dokument hat folgenden Aufbau: Spaltenbeschreibung: Result\Cols\{UpperCaseSpaltenName}@ordinal,@typeName Value = orginalname, wie in der Quelle definiert. Daten: Result\Rows\(0..n) Row\{UpperCaseSpaltenName} = Value = Wert. Hinweise: Spalten mit NULL Werten werden übersprungen. Geometrie-Werte werden in der Iwan internen Stringrepräsentation zurückgegeben. Die Elementnamen der Spalten werden mit EncodeLocalName maskiert, verwende DecodeLocalName zur Generierung der Klarnamens

Argumente

ModifyMapQueryFilterValues(XPathNodeIterator nodeXPathNodeIterator values)

Verfügbar in: eo:iduCore

Modifiziert eine Abfrage für eine Geodatenebene und gibt ein Element QueryTypeWithOutputHint_Type zurück.

Argumente

Now()

Verfügbar in: eo:iduCore

Gibt das aktuelle Datum/Uhrzeit zurück

ParseXml(String xml)

Verfügbar in: eo:iduCore

Erstellt ein NodeSet aus dem als String übergebenem Xml

Argumente

Rückgabe

XML-Knotenmenge

ReformatXmlString(String xml)

Verfügbar in: eo:iduCore

Parsed den String, formatiert das XML und gibt dieses wieder als String aus. Damit dieses korrekt in html ausgegeben wird, muss es von einem pre-Tag umschlossen sein.

Argumente

Rückgabe

String: neu formatiertes XML als String

Replace(StringStringString)

Verfügbar in: eo:iduCore

Ersetzt in einer Zeichenkette alle Vorkommen eines Textfragments durch den Ersetzungstext.

ResolveImageUrlToLocalFile(String imageUri)

Verfügbar in: eo:iduCore

Erstellt einen absoluten Pfad für den Download einer beliebigen Datei.

Je nach Umgebung können auch Variablen verwendet werden (%PATH_XY%).

Es können auch in DLLs eingebettete Resourcen abgerufen werden. Dabei muss als 1. das Assembly, dann der Resource-Name angegeben weden. Bsp.: res://idu.core/IDU.Core/Web/Res/Resources/src/Res.js

Im Web-Modus gilt:

Im Pdf-Modus gilt:

Argumente

SelectNodesByXPathString(XPathNavigator rootElString xpath)

Verfügbar in: eo:iduCore

Gibt ein NodeSet als Ergebnis eines XPath Ausdruck zurück. Der XPath Ausdruck wird hier als Zeichenkette übergeben.

Argumente

SelectSingleNodeByXPathString(XPathNavigator rootElString xpath)

Verfügbar in: eo:iduCore

Gibt einen Single-Node als Ergebnis eines XPath Ausdruck zurück. Der XPath Ausdruck wird hier als Zeichenkette übergeben.

Argumente

SetCounter(String keyInt32 value)

Verfügbar in: eo:iduCore

Setzt den Zähler auf den übergebenen Wert.

Argumente

Rückgabe

Aktuellen Wert des Zählers nach der Operation

SetForcePdfCompatibleURIs()

Verfügbar in: eo:iduCore

Erzwingen PDF-konformer URI's. Dies ist sinnvoll, wenn das Ausgabeformat Html ist, das Ergebnisdokument aber nachträglich mit einer externen Lib in ein PDF umgewandet werden soll (verwenden für HQPrint.net mit Lib HtmlRenderer).

StringJoin(String separatorBoolean skipEmtpyStringXPathNodeIterator stringNode)

Verfügbar in: eo:iduCore

Verbindet alle Werte aus der übergebenen Auflistung zu einer durch separator getrennten Zeichenfolge

Argumente

StringSplit(String separatorString valueBoolean trimEachValue)

Verfügbar in: eo:iduCore

Splittet einen String und gibt ein Nodeset mit den Einzelwerten zurück. Leere Elemente werden immer übersprungen.

Argumente

ToLower(String str)

Verfügbar in: eo:iduCore

Gibt einen String in Kleinbuchstaben zurück, nie null.

Argumente

ToUpper(String str)

Verfügbar in: eo:iduCore

Gibt einen String in Großbuchstaben zurück, nie null.

Argumente

TransformGeom(String geomStringInt32 targetEpsg)

Verfügbar in: eo:iduCore

Transformiert die übergebene Geometrie in die Zielprojektion

Argumente

Rückgabe

transformierte Geometrie in EWKT

AppendPdfDocumentFromCardoPuzzleDocument(Int32 puzzleNodeIdInt32 ikxStoreIdString preferedXsltName)

Verfügbar in: eo:iduPdf

Ruft ein Dokument aus cardo.Puzzle ab und fügt dieses am Ende dieses Dokumentes mit an.

Wichtiger Hinweis: Bei falscher Verwendung besteht die Möglichkeit Endlosschleifen zu generieren!

Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.

Argumente

AppendPdfDocumentFromFile(String sourceFileName)

Verfügbar in: eo:iduPdf

Lädt ein vorhandenes Pdf - Dokument und fügt dieses am Ende des Ausgabe-Pdf mit ein. Die Datei muss aus Sicht des cardo Servers abrufbar sein.

Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.

Argumente

AppendPdfDocumentFromIkxStoredBlob(Int32 ikxStObjectDataIdInt32 ikxStoreId)

Verfügbar in: eo:iduPdf

Lädt ein vorhandenes Pdf - Dokument aus dem Blob Feld eines Ikx-Store und fügt dieses am Ende des Ausgabe-Pdf mit ein. Beachten Sie, dass Berechtigungen geprüft werden (Read-Recht muss gegeben sein.)

Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.

Argumente

CreatePdfAttachmentFromBytes(XPathNodeIterator sourceDataString localFileNameString htmlTocElementIdString description)

Verfügbar in: eo:iduPdf

Bettet Binärdaten als Anhang in das Ausgabe Pdf-Dokument ein. Rückgabe ist ein <span .. mit dem "Büroklammer" Icon.

Argumente

CreatePdfAttachmentFromFile(String sourceFileNameString alternativeFileNameString htmlTocElementIdString description)

Verfügbar in: eo:iduPdf

Bettet eine Datei als Anhang in das Ausgabe Pdf-Dokument ein. Rückgabe ist ein <span .. mit dem "Büroklammer" Icon.

Beispiel

             
             
             
             <xsl:value-of select="cePdf:CreatePdfAttachmentFromFile(
                 $pdfApplicationAttachmentFileName,
                 'Antrag.pdf',
                 'attachment_1_link',
                 'vollständiges Antragsdokument')" disable-output-escaping="yes"/> Antragsdokument
             
             
             
            

Argumente

CreatePdfAttachmentFromIkxStoredBlob(Int32 ikxStObjectDataIdInt32 ikxStoreIdString localFileNameString htmlTocElementIdString description)

Verfügbar in: eo:iduPdf

Bettet eine Blob-Eintrag aus einem Ikx-Datenspeicher als Anhang in das Ausgabe Pdf-Dokument ein. Rückgabe ist ein <span .. mit dem "Büroklammer" Icon.

Argumente

SetMargin(Int32)

Verfügbar in: eo:iduPdf

Setzt die Seitenränder (für alle Seiten)

SetMargins(Int32 marginMmLeftInt32 marginMmRightInt32 marginMmTopInt32 marginMmBottom)

Verfügbar in: eo:iduPdf

Setzt die Seitenränder(einzeln)

Argumente

SetOrientation(String orientation)

Verfügbar in: eo:iduPdf

Ändern das Papier-Format

Argumente

SetPageSize(Int32 widhtMmInt32 heightMm)

Verfügbar in: eo:iduPdf

Setzt die Ausgabegröße

Argumente

SetPageSizeByName(String pageSize)

Verfügbar in: eo:iduPdf

Setzt die Ausgabegröße anhand bekannter Namen (A0 ... A9)

Argumente

SetPdfDocumentProperties(XPathNodeIterator node)

Verfügbar in: eo:iduPdf

Setzt die Dokument-Eigenschaften, wie Author, Title etc.

Argumente

SetPdfDocumentSecurity(XPathNodeIterator node)

Verfügbar in: eo:iduPdf

Setzt die Sicherheits-Optionen für das Pdf Dokument.

Argumente

SetPdfHeaderAndFooter(XPathNodeIterator node)

Verfügbar in: eo:iduPdf

Setzt die Header und Footer Einstellungen für das Pdf Dokument.

Argumente

AppendDocumentFromIkxStoredBlob(Int32 ikxStObjectDataIdInt32 ikxStoreId)

Verfügbar in: eo:iduDocX

Lädt ein vorhandenes Dokument aus dem Blob Feld eines Ikx-Store. Beachten Sie, dass Berechtigungen geprüft werden (Read-Recht muss gegeben sein.) Gibt eine Unique-Id zurück, die im Element <attachmentReference> als Attribut uniqueId eingesetzt werden kann.

Wird mehrfach eine der AppenndDocument -Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.

Argumente

AppendPdfDocumentFromCardoPuzzleDocument(Int32 puzzleNodeIdInt32 ikxStoreIdString preferedXsltName)

Verfügbar in: eo:iduDocX

Ruft ein Dokument aus cardo.Puzzle ab und fügt dieses am Ende dieses Dokumentes mit an.

Wichtiger Hinweis: Bei falscher Verwendung besteht die Möglichkeit Endlosschleifen zu generieren!

Gibt eine Unique-Id zurück, die im Element <attachmentReference> als Attribut uniqueId eingesetzt werden kann.

Wird mehrfach eine der AppendPdfDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.

Argumente

CreateAttachmentFromFile(String sourceFileNameString)

Verfügbar in: eo:iduDocX

Lädt ein Dokument und fügt dieses am Ende des Ausgabe mit ein. Die Datei muss aus Sicht des cardo Servers abrufbar sein. Gibt eine Unique-Id zurück, die im Element <attachmentReference> als Attribut uniqueId eingesetzt werden kann.

Wird mehrfach eine der AppendDocument-Funktionen verwendet, werden die Dokument in der angegebenen Reihenfolge angefügt.

Argumente

SetDocXHeaderAndFooter(XPathNodeIterator node)

Verfügbar in: eo:iduDocX

Setzt die Header und Footer Einstellungen für das DocX Dokument.

Argumente

SetMargin(Int32)

Verfügbar in: eo:iduDocX

Setzt die Seitenränder (für alle Seiten)

SetMargins(Int32 marginMmLeftInt32 marginMmRightInt32 marginMmTopInt32 marginMmBottom)

Verfügbar in: eo:iduDocX

Setzt die Seitenränder(einzeln)

Argumente

SetOrientation(String orientation)

Verfügbar in: eo:iduDocX

Ändern das Papier-Format

Argumente

SetPageSize(Int32 widhtMmInt32 heightMm)

Verfügbar in: eo:iduDocX

Setzt die Ausgabegröße

Argumente

SetPageSizeByName(String pageSize)

Verfügbar in: eo:iduDocX

Setzt die Ausgabegröße anhand bekannter Namen (A0 ... A9)

Argumente

AddLayerByTagsToLayerList(XPathNodeIterator oldLayerListString tagNames)

Verfügbar in: eo:cardo

Fügt Layer, die via LayerTag(s) ermittelt werden, an eine bestehende LayerList an

Argumente

CreateLegendImageByLayerTag(String layerTag)

Verfügbar in: eo:cardo

Gibt die URL zum Legendenbild für eine Ebene, die via Tag übergeben wird, aus

Argumente

GetCurrentApplicationRootUrl(Boolean absoluteBoolean withPathModifier)

Verfügbar in: eo:cardo

Gibt die Url zum Anwendungsroot zurück (z.B. net3), kann kombiniert werden um z.B. den OGC(sl).ashx Handler zu adressieren. Bsp.: für die Rückgabe http://localhost:81/net3/

Argumente

Rückgabe

Die absolute oder relative Adresse zum Root der Anwendung, immer mit endendem Slash

GetFileIconByName(String fileName)

Verfügbar in: eo:cardo

Gibt eine relative Url zum Abrufen des Icons für einen Dateityp zurück, kann mit GetCurrentApplicationRootUrl kombiniert werden.

Argumente

Rückgabe

die Url zum Resource-Handler (res.ashx?Res=xx)

GetLayerListFromMyMap(Int32 myMapId)

Verfügbar in: eo:cardo

Extrahiert die Sichtbaren Ebene aus der angegebenen "Meine Karte". Die Layerliste ist sortiert und enthält die internen Namen (L1).

Hinweis: der Aufrufer muss Rechte an der Karte haben.

Argumente

GetLayerTag(String layerName)

Verfügbar in: eo:cardo

Ermittelt den Anwendungsname (LayerTag) der Ebene.

Argumente

Rückgabe

LayerTag oder null, wenn kein LayerTag vergeben

GetLayerTitle(String layerName)

Verfügbar in: eo:cardo

Ermittelt den Titel der Ebene.

Argumente

Rückgabe

Titel der Ebene

GetPuzzleDataByQPzlId(String qPzlId)

Verfügbar in: eo:cardo

Gibt das XML-Dokument zu einem beliebigen Puzzle-Dokument heraus (AllAvailableContent).

Argumente

GetPuzzleDataForNode(Int32 puzzleNodeIdInt32 ikxStoreId)

Verfügbar in: eo:cardo

Gibt das XML-Dokument zu einem beliebigen Puzzle-Dokument heraus Mit allem was es gibt dran (AllAvailableContent)

Argumente

Rückgabe

das XML-Document

GetVisibleLayerListFromView(Int32 viewId)

Verfügbar in: eo:cardo

Gibt die sortierte Layerliste der sichtbaren Ebenen an denen der Benutzer das LayerRendering Recht hat aus dem übergeben View zurück. Ist die ViewId kleiner gleich 0, wird der erste cardo Ebenenbaum verwendet.

Argumente

Hinweise

Die Aufrufe werden in der Instanz gecached

IkxCheckEntityExists(String classIdString entityId)

Verfügbar in: eo:cardo

Prüft, ob die angegebene Entität in der angegebenen Klasse existiert

Argumente

Rückgabe

true - Entität existiert

IkxGetClassDescription(String classId)

Verfügbar in: eo:cardo

Gibt die Beschreibung für die Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.

Argumente

Rückgabe

Die Beschreibung der Klasse in der aktuell eingestellten Sprache

Hinweise

Die Klasse / Entität muss vorhanden sein.

IkxGetClassLabel(String classId)

Verfügbar in: eo:cardo

Gibt den Anzeigetitel für die Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.

Argumente

Rückgabe

Der Label der Klasse in der aktuell eingestellten Sprache

Hinweise

Die Klasse muss vorhanden sein.

IkxGetClassXml(String classId)

Verfügbar in: eo:cardo

Ruft die Struktur einer IkxClass in Form der Ikx-Klassenexport Xml Beschreibung ab.

Argumente

IkxGetEntityDescription(String classIdString entityId)

Verfügbar in: eo:cardo

Gibt die Beschreibung für die Entität Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.

Argumente

Rückgabe

Die Beschreibung der Klasse in der aktuell eingestellten Sprache

Hinweise

Die Klasse / Entität muss vorhanden sein.

IkxGetEntityGroupName(String classIdString entityId)

Verfügbar in: eo:cardo

Gibt den Namen der Feldgruppe für die Entität Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.

Argumente

Rückgabe

Die Beschreibung der Klasse in der aktuell eingestellten Sprache

Hinweise

Die Klasse / Entität muss vorhanden sein.

IkxGetEntityLabel(String classIdString entityId)

Verfügbar in: eo:cardo

Gibt den Anzeigetitel für die Entität mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.

Argumente

Rückgabe

Der Label der Entität in der aktuell eingestellten Sprache

Hinweise

Die Entität muss vorhanden sein.

IkxGetEntitySortHint(String classIdString entityId)

Verfügbar in: eo:cardo

Gibt ein Sortierfeld zurück, beachtet dabei auch die Gruppensortierung

Argumente

IkxGetEntityTabName(String classIdString entityId)

Verfügbar in: eo:cardo

Gibt den Namen der Tab-Seite für die Entität Klasse mit der angegeben Id aus dem aktuell selektierten Ikx Store zurück.

Argumente

Rückgabe

Die Beschreibung der Klasse in der aktuell eingestellten Sprache

Hinweise

Die Klasse / Entität muss vorhanden sein.

IkxIsEntityMeaningSet(XPathNodeIterator givenMeaningString toCompare)

Verfügbar in: eo:cardo

Prüft, auf givenMeaning.HasFlag(toCompare), Beide Werte werden in MDEntityMeanings konvertiert.

Argumente

IkxIsStoreSelected()

Verfügbar in: eo:cardo

Gib true zurück, wenn aktuell ein Ikx Datenspeicher selektiert ist. Siehe auch Hinweis zu IkxSelectIkxStore.

IkxRenderMimeTypeValueToHtml(String kindOfMimeTypeString valueString additionalData)

Verfügbar in: eo:cardo

Generieren des Html-Code für ein Datenfeld mit MimeType Handler, aufgerufen wird die RenderToHtml des installierten MimeType-Handler.

Argumente

IkxSelectIkxStore(Int32 ikxStoreId)

Verfügbar in: eo:cardo

Wählt einen Ikx Datenspeicher aus, der für alle folgenden Ikx** Aufrufe verwendet wird. Diese Methode muss vor dem Aufruf der anderen Ikx** Methoden aufgerufen werden. Es kann sein, dass die Umgebung bereits einen Store selektiert hat, dies ist Abhängig vom Modul in dem diese Ikx Erweiterung eingesetzt wird. Zurückgegeben wird die vorherige Ikx-Store-id

Argumente

IsAnonymous()

Verfügbar in: eo:cardo

Gibt an, ob der Aufruf der aktuellen Abarbeitung als Anonymous erfolgt.

IsUserIsInRole(String roleName)

Verfügbar in: eo:cardo

Gibt true zurück, wenn der aktuell angemeldete Benutzer Mitglied in der übergebenen Gruppe ist

Argumente

UserDescription(String userName)

Verfügbar in: eo:cardo

Gibt die Beschreibung zum übergebenen Benutzernamen zurück.

Argumente

UserName()

Verfügbar in: eo:cardo

Gibt den Login-Namen des aktuellen Benutzers zurück.

XPathToNode(IXPathNavigable rootObject param)

Verfügbar in: eo:cardo

Versucht, den übergebenen Wert wie nachfolgend aufgelistet zu interpretieren: - ist der Parameter bereits ein XML-Node -> unverändert zrückgegeben - ist der Parameter ein Pfad und ist der Knoten auf den verwiesen wird nicht leer -> Knoten zurück - ist der Parameter ein String und als XPath interpretierbar -> Knoten zurück - ist der Parameter ein String aber kein XPath -> fixer Wert -> als String zurück ansonsten String "XPathToNode:emptyResult" zurück zur Erkennung leere Ergebnismenge

Argumente

Rückgabe

siehe oben