Propriedades

<< Clique para Mostrar o Sumário >>

 

Propriedades

A tabela a seguir contém as propriedades do objeto hpXMLCatalog.

Propriedades do objeto hpXMLCatalog

Propriedade

Descrição

ExtraProperties

Parâmetros personalizados para o código XML. Para mais informações, consulte o tópico Parâmetros Personalizados

FriendlyNameProperty

Nome da propriedade do objeto de dados que contém o texto dos nós do objeto hpTreeView. Para exibir a denominação dos nós com o valor da propriedade Caption dos objetos de dados, por exemplo, o valor desta propriedade deve ser igual a "Caption"

FriendlyTipProperty

Nome da propriedade do objeto de dados que contém o texto da dica dos nós do objeto hpTreeView. Para exibir a dica de cada nó com o valor da propriedade DocString dos objetos de dados, por exemplo, o valor desta propriedade deve ser igual a "DocString"

GetAllChildren

Retorna os objetos filhos em todos os níveis da árvore. Se esta propriedade é configurada em False, retorna somente o primeiro nível hierárquico

HideDataType

Tipo ou tipos de objetos a serem excluídos da consulta

HideObjectName

Nome ou nomes de objetos a serem excluídos da consulta

InitialPath

Lista de pastas a serem lidas para gerar o código XML, separadas por ponto e vírgula

InvalidCharReplacement

Indica o caractere para substituição de caracteres inválidos no código XML. Os valores possíveis são 0: Remove o caractere sem substituir, 1: Substitui pelo caractere de sublinhado (ASCII 95), 2: Substitui pelo caractere de espaço (ASCII 32), 3: Substitui pelo caractere de hífen (ASCII 45), 4: Substitui pelo sinal de mais (ASCII 43) ou 5: Substitui pelo ponto de interrogação (ASCII 63)

KeywordProperty

Nome da propriedade, no objeto fonte, que contém a palavra-chave ou palavras-chave

NormalizeBranchCheckState

Normaliza o valor da seleção das caixas de seleção nos nós em cada ramificação onde ao menos um nó, o parâmetro C, foi alterado no código XML. Se o valor desta propriedade é igual a True, o usuário pode declarar, na propriedade ExtraProperties, o parâmetro reservado C. Caso contrário é mostrado um alerta sobre o conflito do parâmetro declarado com o parâmetro reservado

OutputMode

Especifica o local onde o código XML é gerado. Os valores possíveis são 0: Gera um único código XML e salva este código na propriedade xmlOutput (padrão) ou 1: Gera um código XML específico para cada objeto do tipo xfPlantFolder ou equivalente encontrado na varredura, salvando este código na propriedade xmlData de cada objeto xfPlantFolder ou equivalente

Run

Gera um novo código XML se o valor é igual a True

RunOnStart

Gera o código XML na inicialização da aplicação. Recomenda-se deixar este valor em False para um melhor desempenho na inicialização da aplicação

ScanNodeAfterSave

Afeta o modo como é realizada a varredura pela árvore de objetos. Esta propriedade é válida apenas quando a propriedade OutputMode é igual a 1 (um). Os valores possíveis são True: Permite que, após salvar o código XML na propriedade xmlData de um nó do tipo xfPlantFolder ou equivalente, o objeto hpXMLCatalog continue a varredura pelos filhos deste nó, a fim de que, caso encontre mais filhos do tipo xfPlantFolder ou equivalente cuja propriedade StoreXML seja igual a True, os respectivos códigos XML sejam também gravados ou False: Permite que, após gravar o código XML no primeiro objeto xfPlantFolder ou equivalente encontrado cuja propriedade StoreXML seja igual a True, o objeto hpXMLCatalog interrompa a varredura neste nó e passe ao nó seguinte, ignorando todos os filhos do objeto alterado. NOTA: Para um melhor desempenho, o valor desta propriedade deve permanecer em False sempre que possível

ShowDataType

Tipo ou tipos de objetos a serem incluídos na consulta. Um valor vazio nesta propriedade retorna todos os tipos de objetos

ShowObjectName

Nome ou nomes de objetos a serem incluídos na consulta. Um valor vazio nesta propriedade retorna todos os nomes de objetos

ShowRootFolder

Se configurada para True, o nó raiz das pastas incluídas na propriedade InitialPath é incluído no código XML. Se configurada para False, o nó raiz não é incluído no código XML

xmlCurrentFolder

Exibe o nome da pasta em análise ao gerar o código XML no Studio

xmlOutput

Código XML finalizado

xmlProgress

Exibe o andamento da geração do código XML no Studio

XMLTemplate

Modifica o código XML resultante com base em um modelo pré-definido. Os valores possíveis para esta propriedade são 0: Modelo definido pelo usuário na propriedade ExtraProperties, 1: Modelo para uso pelo objeto hpTreeView, 2: Modelo para uso pelo objeto hpLyraMenu, 3: Modelo para uso pela Tela Faceplate, 4: Modelo para uso pelo FlexControl, 5: Modelo para uso pelo objeto hpTreeView (modo compactado) ou 6: Modelo para uso pela função de navegação

XRefMode

Configura a forma de tratamento dos objetos xfPMRef. Os valores possíveis são 0: Mantém os nós de referências externas no código XML, 1: Remove os nós de referências externas e mescla o conteúdo no código XML

 

NOTAS

Objetos equivalentes ao objeto xfPlantFolder são XFolders que tenham as mesmas propriedades StoreXML e xmlData dos objetos do tipo xfPlantFolder. Sem estas propriedades, o objeto hpXMLCatalog não armazena no objeto o código XML gerado.

Caso os nomes das propriedades informadas nas propriedades FriendlyNameProperty e FriendlyTipProperty não existam ou o valor seja uma String vazia, o texto dos nós usa o valor da propriedade Name do objeto e o texto das dicas dos nós é configurado com uma String vazia e, portanto, a dica é desativada.

As propriedades FriendlyNameProperty e FriendlyTipProperty, quando usadas como parâmetros personalizados na propriedade ExtraProperties para geração de código XML, usam os códigos FNP e FTP, respectivamente.

O novo comportamento da dica, ou tip, representa uma quebra de compatibilidade, pois antes era exibida apenas a denominação, ou seja, a propriedade Name do próprio nó como dica. Para retomar o comportamento anterior, configure a propriedade FriendlyTipProperty com o valor "Name". Caso não deseje traduzir a dica, crie um termo no dicionário da aplicação onde cada idioma deve ser configurado com o valor original.

Esta página foi útil?