StoryFragment Classe

Définition

Espace de noms:

System.Windows.Documents.DocumentStructures

Assembly:

PresentationFramework.dll

Représente tout ou partie d’un article dans un document XPS.

public ref class StoryFragment : System::Collections::Generic::IEnumerable<System::Windows::Documents::DocumentStructures::BlockElement ^>, System::Windows::Markup::IAddChild

[System.Windows.Markup.ContentProperty("BlockElementList")]
public class StoryFragment : System.Collections.Generic.IEnumerable<System.Windows.Documents.DocumentStructures.BlockElement>, System.Windows.Markup.IAddChild

[<System.Windows.Markup.ContentProperty("BlockElementList")>]
type StoryFragment = class
    interface seq<BlockElement>
    interface IEnumerable
    interface IAddChild

Public Class StoryFragment
Implements IAddChild, IEnumerable(Of BlockElement)

Héritage

Object

StoryFragment

Attributs

ContentPropertyAttribute

Implémente

IAddChild IEnumerable<BlockElement> IEnumerable

Exemples

L’exemple suivant montre la <StoryFragment> partie d’un document XPS (XML Paper Specification).

<StoryFragment StoryName="DocumentBody" FragmentType="Content">
  <SectionStructure>
    <ParagraphStructure>
      <NamedElement NameReference="Pg1Heading1" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1P1" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1P2" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1P3" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1P4" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1P5" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1Heading2" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1P6" />
    </ParagraphStructure>

    <ParagraphStructure>
      <NamedElement NameReference="Pg1P7" />
    </ParagraphStructure>

    <TableStructure>
      <TableRowGroupStructure>

        <TableRowStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R1C1P1" />
            </ParagraphStructure>
          </TableCellStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R1C2P1" />
            </ParagraphStructure>
          </TableCellStructure>
        </TableRowStructure>

        <TableRowStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R2C1P1" />
            </ParagraphStructure>
          </TableCellStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R2C2P1" />
            </ParagraphStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R2C2P2" />
            </ParagraphStructure>
          </TableCellStructure>
        </TableRowStructure>

        <TableRowStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R3C1P1" />
            </ParagraphStructure>
          </TableCellStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R3C2P1" />
            </ParagraphStructure>
          </TableCellStructure>
        </TableRowStructure>

        <TableRowStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R4C1P1" />
            </ParagraphStructure>
          </TableCellStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R4C2P1" />
            </ParagraphStructure>
          </TableCellStructure>
        </TableRowStructure>

        <TableRowStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R5C1P1" />
            </ParagraphStructure>
          </TableCellStructure>
          <TableCellStructure>
            <ParagraphStructure>
              <NamedElement NameReference="R5C2P1" />
            </ParagraphStructure>
          </TableCellStructure>
        </TableRowStructure>

      </TableRowGroupStructure>
    </TableStructure>
  </SectionStructure>
</StoryFragment>

Remarques

Une histoire XPS dans un document XPS est à peu près analogue à une histoire dans un journal ou un magazine. Il s’agit d’un passage de texte et de contenu graphique, généralement sur une seule rubrique, dans un seul document XPS. En règle générale, il s’étend sur plusieurs pages, mais il peut être plus court qu’une page comme une barre latérale - histoire en boîte - dans un magazine. Un article peut également être discontinu comme un article de journal en première page qui est continué à la page 4. Par conséquent, une page donnée peut avoir plusieurs histoires et des parties de plusieurs histoires. Un en-tête ou un pied de page est également un type spécial d’histoire qui est entièrement contenu sur une seule page.

Représente StoryFragment la totalité ou une partie d’une histoire. Il ne peut jamais s’étendre sur plusieurs pages, mais il peut occuper l’ensemble d’une page ou partager une page avec d’autres fragments. Si une histoire se trouve sur plusieurs pages, chaque partie de celle-ci sur chaque page est un fragment distinct. Bien que les histoires puissent avoir des ensembles discontinus de fragments, aucun fragment ne peut lui-même être discontinu.

Seul un StoryFragments élément peut être un parent d’un StoryFragment. L’emplacement des StoryBreak éléments dans un StoryFragment indique si l’histoire est contenue dans plusieurs fragments et si les fragments supplémentaires précèdent ou suivent le fragment actuel.

Lorsqu’un StoryFragment se termine au milieu d’un élément structurel , par exemple , <TableRowGroupStructure>les applications de production de documents XPS doivent insérer une balise de fin appropriée pour l’élément (dans ce cas </TableRowGroupStructure>) avant la </StoryFragment> balise, même si la structure est poursuivie dans un fragment ultérieur. (Cela est nécessaire pour s’assurer que l’arborescence d’éléments dans le est du StoryFragment CODE XML valide.) Le fragment qui continue l’histoire doit commencer par une balise d’ouverture pour la structure interrompue. L’ensemble de l’arborescence des structures interrompues doit être traité de la même façon (à une exception près, décrite ci-dessous) : les balises de fin doivent être ajoutées pour chaque balise de début sans correspondance au-dessus du point d’interruption.

L’exception s’applique lorsque l’interruption de l’histoire arrive immédiatement après une </TableCellStructure> balise, alors que l’application qui produit doit insérer une structure de cellule de table vide (<TableCellStructure></TableCellStructure>) au point correspondant dans le fragment qui continue l’histoire. Cela est nécessaire pour que les applications consommatrices qui doivent fusionner tous les fragments d’une histoire donnée puissent utiliser un algorithme simple pour ce faire.

Supposons, par exemple, qu’une application souhaitait ajouter le matériel suivant à un document XPS :

<SectionStructure>  
   <TableStructure>  
      <TableRowGroupStructure>  
         <TableRowStructure>  
            <TableCellStructure>  
               <ParagraphStructure>  
                  <NamedElement NameReference="SomeContent" />  
               </ParagraphStructure>  
            </TableCellStructure>  
            <TableCellStructure>  
               <ParagraphStructure>  
                  <NamedElement NameReference="MoreContent" />  
               </ParagraphStructure>  
            </TableCellStructure>  
         </TableRowStructure>  
         <TableRowStructure>  
            <TableCellStructure>  
               <ParagraphStructure>  
                  <NamedElement NameReference="EvenMoreContent" />  
               </ParagraphStructure>  
            </TableCellStructure>  
            <TableCellStructure>  
               <ParagraphStructure>  
                  <NamedElement NameReference="LastContent" />  
               </ParagraphStructure>  
            </TableCellStructure>  
         </TableRowStructure>  
      </TableRowGroupStructure>  
   </TableStructure>  
</SectionStructure>  

Si un saut de page force la fin du fragment juste après le </TableCellStructure> pour « SomeContent », l’application doit créer le fractionnement comme illustré dans l’exemple suivant :

<StoryFragment StoryName="MyStory" FragmentType="Content">  
 <SectionStructure>  
    <TableStructure>  
       <TableRowGroupStructure>  
          <TableRowStructure>  
             <TableCellStructure>  
                <ParagraphStructure>  
                   <NamedElement NameReference="SomeContent" />  
                </ParagraphStructure>   
             </TableCellStructure>  
<!-- lines from here to end of fragment added by producer-->  
          </TableRowStructure>  
       </TableRowGroupStructure>  
    </TableStructure>  
 </SectionStructure>  
</StoryFragment>  

<StoryFragment StoryName="MyStory" FragmentType="Content">  
 <SectionStructure>  
    <TableStructure>  
       <TableRowGroupStructure>  
          <TableRowStructure>  
             <TableCellStructure>   
              <!-- extra cell added by producer-->  
             </TableCellStructure>  
<!-- lines from here to start of fragment added by producer-->  
             <TableCellStructure>  
                <ParagraphStructure>  
                   <NamedElement NameReference="MoreContent" />  
                </ParagraphStructure>  
             </TableCellStructure>  
          </TableRowStructure>  
          <TableRowStructure>  
             <TableCellStructure>  
                <ParagraphStructure>  
                   <NamedElement NameReference="EvenMoreContent" />  
                </ParagraphStructure>  
             </TableCellStructure>  
             <TableCellStructure>  
                <ParagraphStructure>  
                   <NamedElement NameReference="LastContent" />  
                </ParagraphStructure>  
             </TableCellStructure>  
          </TableRowStructure>  
       </TableRowGroupStructure>  
    </TableStructure>  
 </SectionStructure>  
</StoryFragment>  

Une application qui lit le document peut avoir besoin de fusionner ce contenu. Prenons l’exemple d’une visionneuse XPS avec un bouton Copier toute l’histoire dans le Presse-papiers ; ou un XPS pour l’application Blind qui a transmis des histoires à un synthétiseur vocal. Certaines applications qui lisent le document peuvent avoir besoin de fusionner un sous-ensemble des fragments d’un article. Par exemple, une fonctionnalité qui copie un paragraphe entier dans le Presse-papiers en triple cliquant dessus doit effectuer une fusion chaque fois que le paragraphe s’étend sur un saut de page, car un tel paragraphe serait divisé entre deux StoryFragments.

Pour fusionner, utilisez cet algorithme :

1. Supprimez le </StoryFragment> de la fin du premier fragment à fusionner et supprimez le <StoryFragment> du début du second.

2. Si la dernière balise fermante du premier fragment est du même type que la première balise d’ouverture du deuxième fragment (et qu’il ne s’agit pas <NamedElement> de balises), supprimez-les toutes les deux.

3. Répétez l’étape 2 jusqu’à ce que les deux fragments se trouvent dans l’un des états suivants :

   • Il n’existe plus de correspondance de type entre la dernière balise de fin du fragment de tête et la première balise de début du fragment de fin.

   • La dernière balise de fin du fragment principal, la première balise de début du fragment de fin sont les deux <NamedElement> balises.

Dans l’exemple ci-dessus, si la cellule vide n’avait pas été ajoutée par l’application qui produit, une fusion des fragments produirait une table dont la première ligne n’avait qu’une seule cellule contenant les références « SomeContent » et « MoreContent » au lieu de la première ligne d’origine avec deux cellules, chacune contenant une seule référence

Lorsque l’intégralité de l’histoire est fusionnée, l’algorithme doit être répété pour chaque fragment suivant qui fait partie de la même histoire. Les fragments qui appartiennent à une histoire sont indexés dans l’élément <Story> . Consultez la section 9.1.15 de la spécification DE PAPIER XML (XPS) que vous pouvez obtenir sur XPS : Spécification et téléchargements de licences. Le dernier fragment d’une histoire donnée aura un StoryBreak élément comme dernier enfant.

Constructeurs

StoryFragment()

Initialise une nouvelle instance de la classe StoryFragment.

Propriétés

FragmentName	Obtient ou définit le nom du fragment d'article.
FragmentType	Obtient ou définit le type de fragment.
StoryName	Obtient ou définit le nom de l'article.

Méthodes

Add(BlockElement)	Ajoute un bloc au fragment d'histoire.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

IAddChild.AddChild(Object)	Ce membre prend en charge l'infrastructure .NET Framework et n'est pas destiné à être utilisé directement à partir de votre code.
IAddChild.AddText(String)	Ajoute le contenu textuel d’un nœud à l’objet.
IEnumerable.GetEnumerator()	Cette méthode n’a pas encore été implémentée.
IEnumerable<BlockElement>.GetEnumerator()	Cette méthode n’a pas encore été implémentée.

Méthodes d’extension

Voir aussi

• StoryBreak
• StoryFragments