|
<< Clique para Mostrar o Sumário >>
Parâmetros Personalizados |
É possível configurar parâmetros personalizados no código XML, tendo como base:
•Uma propriedade existente de um objeto
•Propriedades reservadas do objeto hpXMLCatalog
•Um valor padrão definido pelo usuário
A seguir são detalhados cada um destes tipos de parâmetros.
Para criar um parâmetro personalizado com base no valor de uma propriedade existente de um objeto, use a propriedade ExtraProperties. Os parâmetros personalizados devem ser declarados nesta propriedade obedecendo o formato Propriedade=Alias, onde Propriedade é o nome da propriedade existente no objeto e Alias é o nome do parâmetro a ser incluído no código XML.
Por exemplo, para incluir o valor da propriedade Caption de um objeto, selecione um Alias para o parâmetro. Este Alias deve ser diferente de todos os demais que já estejam em uso no código XML e na propriedade ExtraProperties. Para isto, consulte os tópicos indicados a seguir.
•Parâmetros pré-definidos do objeto hpXMLCatalog
•Parâmetros adicionais compatíveis com o objeto hpTreeView
•Parâmetros adicionais compatíveis com o objeto hpLyraMenu
•Parâmetros adicionais compatíveis com a Tela Faceplate
Após verificar os possíveis conflitos, use a expressão "CA" como Alias exclusivo para o parâmetro da propriedade Caption. Neste caso, o formato da declaração na propriedade ExtraProperties é o seguinte:
Caption=CA
O resultado no código XML é a inclusão do parâmetro CA com o valor da propriedade Caption, da seguinte forma:
CA="TMGT"
Pode-se declarar mais de um parâmetro personalizado na propriedade ExtraProperties. Para isto, separe-os por ponto e vírgula, como no exemplo a seguir.
Caption=CA;Value=VA;Tip=TI
O resultado no código XML é o seguinte:
CA="TMGT" VA="True" TI="Temperatura do MGT"
As propriedades listadas a seguir são reservadas para uso exclusivo do objeto hpXMLCatalog e podem ser declaradas na propriedade ExtraProperties com qualquer Alias selecionado pelo usuário, desde que seja exclusivo.
Propriedade reservadas para uso na propriedade ExtraProperties
Propriedade |
Valor Retornado |
ParentPathName |
Propriedade PathName do objeto pai |
Por exemplo, ao declarar na propriedade ExtraProperties uma propriedade reservada no formato a seguir:
ParentPathName=PPN
Neste caso, o objeto hpXMLCatalog identifica a propriedade como reservada e atribui o valor correspondente ao Alias, que é o valor da propriedade PathName do objeto pai.
<Elm N="XObject11" P="Dados1.XObject11" PPN="Dados1"
NOTAS |
•Um Alias deve ter um ou mais caracteres, e recomenda-se um número reduzido de caracteres para que o código XML final também tenha um tamanho reduzido, o que melhora o desempenho de processamento e tráfego de dados. •Caso a propriedade declarada na propriedade ExtraProperties não exista em um determinado objeto, e não seja uma propriedade reservada, então esta propriedade não é incluída no nó do código XML que corresponde a este objeto. •Propriedades reservadas são incluídas em todos os nós do código XML. |
Para criar um parâmetro personalizado tendo por base um valor padrão definido pelo usuário, deve-se usar a propriedade CustomParameters, no formato a seguir.
ParamName{DefaultValue};...;ParamName{DefaultValue}
O valor padrão de cada parâmetro deve ser declarado após o nome e entre chaves. Se omitido, o valor padrão é assumido como uma String vazia, conforme o exemplo a seguir.
CustomParameters = CP1{v1};CP2;CP3{};CP4{v'4}
Esta configuração gera a saída a seguir no código XML, para todos os nós.
CP1='v1' CP2='' CP3='' CP4='v_4'
O valor padrão não pode conter os caracteres de aspas simples ('), ponto e vírgula (;) e chave de abertura ({).
O usuário deve configurar parâmetros com nomes diferentes dos demais parâmetros existentes no código XML, caso contrário o valor do parâmetro existente é sobrescrito pelo valor do parâmetro personalizado.