Programmatisk tillgång till sidinnehåll

Dynamix tillåter redaktören att fritt infoga text och andra innehåll genom det inbyggda redigeringsgränssnittet. I många fall kan det dock vara intressant att hjälpa redaktören på traven genom att i förväg skapa innehåll i sidor. Det kan handla om att importera innehåll från en annan webbplats vid t ex migrering. Det kan också vara att hämta rubriker och bilder från ett rss-flöde eller kanske från ett nyhetsobjekt som kan redigeras i ett Dynamix-verktyg.

Objektmodellen

Låt oss först ta en titt på hur Dynamix lagrar sidinnehåll. De flesta Dynamix-utvecklare har arbetat med objekt av typen NavigationItem – för navigationer och länkar eller kanske för att programmatiskt bygga upp en struktur under utvecklingen. Dessa poster kallar man ofta för sidor. I den här artikeln är vi dock mer intresserade av den lite lägre nivån där själva innehållet – texter och bilder – lagras. Detta görs i objekt av typen Dynamix.Page. För tydlighets skull kallar vi nedan sådana objekt för innehållssidor.

På toppnivån i innehållssidorna ligger objekt av typen Dynamix.Content5.PageComponent. De skapas automatiskt utifrån motsvarande Dynamix. TemplateComponent objekt i den mall som används. Det finns ett antal typer av PageComponents för hantering av t ex formulär och det är också möjligt att bygga egna för valfria sidinställningar. I denna artikel kommer vi dock att koncentrera oss på innehållskomponenten ContentPageComponent.

Inuti en innehållskomponent finns egenskapen Element. Även denna kan vara av flera olika typer men i exemplen här utgår vi från att den är av typen FlowLayoutContentElement som är en generell behållare för texter, bilder och alla andra typer av innehåll.

Elementflödet

En FlowLayoutContentElement har egenskapen Elements. I denna lista ligger det innehåll som ritas ut i sidan. Det kan vara vilken typ av innehåll som helst som ärver från ContentElement – t ex bilder (ImageElement), sökträffar (SearchMatchesElement), html (HtmlElement) eller textfält (TextBoxElement). Det kan givetvis också vara en helt egenutvecklad klass.

Låt oss prova med att skriva in ett html-innehåll i en sida.

Det första steget är att få tag i ett lämpligt Page-objekt. Vi utgår från att vi känner till vår NavigationItem och går via versionhanteraren till den just nu publika versionen.

  1. C#
  1. NavigationItem item;
  2. var page = (Page)item.VersionManager.PublicVersion.Object;

Vi använder sedan det namn vi har använt på mallkomponenten för att hitta den

  1. C#
  1. var ctc = (Dynamix.Content5.ContentTemplateComponent)item.Template.GetComponent( "Main" );

Mallkomponenten använder vi för att hitta vår innehållskomponent

  1. C#
  1. var cpc = (ContentPageComponent)ctc.GetPageComponent( p );

Slutligen har vi nu tillgång till innehållselementet, som vi antar är en FlowLayout

  1. C#
  1. var f = (FlowLayoutContentElement)cpc.Element;

Nästa steg är då att sätta flödesbehållaren i redigeringsläge och skriva dit ett html-innehåll. Sedan sparar vi den igen:

  1. C#
  1. f = f.GetEditableCopy();
  2. var htmlElt = new HtmlElement { Html = "<div style=\"background-color:red\">Test</div>" };
  3. f.Elements.Add( htmlElt );
  4. f.DB_Save();

Om vi kombinerar detta till en återanvändbar funktion får vi:

  1. C#
  1. private static void AddContent( NavigationItem item, string sectionName, IEnumerable<ContentElement> elements )
  2. {
  3. var p = (Page)item.VersionManager.PublicVersion.Object;
  4. var ctc = (Dynamix.Content5.ContentTemplateComponent)item.Template.GetComponent( sectionName );
  5. var cpc = (ContentPageComponent)ctc.GetPageComponent( p );
  6. var f = (FlowLayoutContentElement)cpc.Element.GetEditableCopy();
  8. foreach( var contentElement in elements )
  9. {
  10. f.Elements.Add( contentElement );
  11. }
  13. f.DB_Save();
  14. }

Funktionen kan då anropas med t ex:

  1. C#
  1. private static void AddSearchContent( NavigationItem searchItem, string componentName, TreeObject rootItem )
  2. {
  3. var s = SearchContentType.Instance.CreateElement();
  4. var searchMatchesElement = SearchMatchesContentType.Instance.CreateElement();
  5. searchMatchesElement.Root = rootItem;
  7. AddContent( searchItem, componentName, new ContentElement[] { s, searchMatchesElement } );
  8. }

Textinnehåll

Mellan de specialiserade elementen i elementflödet ligger s.k. textfragment (TextFragmentElement). Dessa innehåller i sin tur textstycken och punktlistor, länkar och formateringar.

För att lägga in text programmatiskt behöver vi alltså först skapa ett textfragment:

  1. C#
  1. var textFrag = new TextFragmentContentElement();

I egenskapen Nodes lägger vi sedan till ett textstycke (Paragraph). Egenskapen Style fylls i till att peka på en tidigare definierad textstil. Inuti textstycket lägger vi en textnod med själva texten.

  1. C#
  1. var para = new Paragraph { Style = MyHeadline1TextStyle.Instance };
  2. textFrag.Nodes.Add( para );
  4. var text = new TextParagraphNode( "En exempeltext" );
  5. para.Nodes.Add( text );

Vill vi ha fler stycken lägger vi bara till dessa i Nodes-listan. Vi kan sedan anropa AddContent-metoden med textfragment i elements-listan:

  1. C#
  1. private static void AddSearchContent( NavigationItem searchItem, string componentName, TreeObject rootItem )
  2. {
  3. var headline = new TextFragmentContentElement();
  4. var headlinePara = new Paragraph { Style = MyHeadline1TextStyle.Instance };
  5. headline.Nodes.Add( headlinePara );
  6. headlinePara.Nodes.Add( new TextParagraphNode( "Sök med hjälp av fältet nedan") );
  8. var s = SearchContentType.Instance.CreateElement();
  9. var searchMatchesElement = SearchMatchesContentType.Instance.CreateElement();
  10. searchMatchesElement.Root = rootItem;
  12. AddContent( searchItem, componentName, new ContentElement[] { headline, s, searchMatchesElement } );
  13. }

Lägg inte flera textfragment i rad i Elements-listan då det kan leda till felaktigt uppträdande när redaktören redigerar i sidan. Använd istället flera Paragraph-noder för att skapa flera stycken med text.

Formaterad text

För att formatera enskilda delar av texten lägger vi in noder av typen FormattedParagraphNode inuti stycken. Egenskapen Format knyts till önskat format

  1. C#
  1. para.Nodes.Add( new TextParagraphNode( "Ett " ) );
  3. var boldText = new FormattedParagraphNode { Format = BoldParagraphNodeFormat.Instance };
  4. boldText.Nodes.Add( new TextParagraphNode( "viktigt" ) );
  5. para.Nodes.Add( boldText );
  7. para.Nodes.Add( new TextParagraphNode( " meddelande." ) );

De format som finns att välja mellan är:

  • Fetstil – BoldParagraphNodeFormat

  • Kursiv/Emfas – ItalicsParagraphNodeFormat

  • Understrykning – UnderlineParagraphNodeFormat

  • Nedsänkt – SubscriptParagaphNodeFormat

  • Upphöjd – SuperscriptParagraphNodeFormat

  • Genomstruken – StrikeThroughParagaphNodeFormat

  • Citat – QuoteParagraphNodeFormat

  • Format-noder kan nästlas i varandra.

Länkar

Länkar i texten skapas genom nodtypen LinkParagraphNode. Egenskapen Link används för att koppla till önskad länk. Inuti länknoden placeras textnoder för själva länktexten.

  1. C#
  1. para.Nodes.Add( new TextParagraphNode( "För mer information: " ) );
  3. var link = new LinkParagraphNode
  4. {
  5. Link = new NavigationItemLink() { NavigationItem = myNavItem }
  6. };
  7. link.Nodes.Add( new TextParagraphNode( "klicka här" ) );
  9. para.Nodes.Add( link );