This example demonstrates how to add different field inlines as well as how to use a range visitor delegate to update all fields in a block tree.
Press the "Update All Fields" button to update all fields.

| Language: C# |
using Nevron.Nov;
using Nevron.Nov.Dom;
using Nevron.Nov.Graphics;
using Nevron.Nov.Layout;
using Nevron.Nov.Text;
using Nevron.Nov.UI;
using Nevron.Nov.Windows.Forms;
using System.Windows.Forms;
namespace NovWinFormsProject
{
public partial class Form1 : Form
{
#region Constructors
public Form1()
{
InitializeComponent();
// Set form title
Text = "NOV WinForms - NFieldInlinesExample";
// Create the NOV example and its controls
NWidget exampleContent = CreateExampleContent();
NWidget exampleControls = CreateExampleControls();
if (exampleControls != null)
{
exampleControls.PreferredWidth = 300;
}
// Place the example and its controls in a pair box
NPairBox pairBox = new NPairBox(exampleContent, exampleControls);
pairBox.FillMode = ENStackFillMode.First;
pairBox.FitMode = ENStackFitMode.First;
pairBox.Margins = new NMargins(NDesign.HorizontalSpacing, NDesign.VerticalSpacing);
// Host the example in the form
NNovWidgetHost host = new NNovWidgetHost(pairBox);
host.Dock = DockStyle.Fill;
Controls.Add(host);
}
#endregion
#region Example
public NWidget CreateExampleContent()
{
// Create the rich text
NRichTextViewWithRibbon richTextWithRibbon = new NRichTextViewWithRibbon();
m_RichText = richTextWithRibbon.View;
m_RichText.AcceptsTab = true;
m_RichText.Content.Sections.Clear();
// Populate the rich text
PopulateRichText();
return richTextWithRibbon;
}
public NWidget CreateExampleControls()
{
NStackPanel stack = new NStackPanel();
NButton updateAllFieldsButton = new NButton("Update All Fields");
updateAllFieldsButton.Click += OnUpdateAllFieldsButtonClick;
stack.Add(updateAllFieldsButton);
return stack;
}
public string GetExampleDescription()
{
return @"
This example demonstrates how to add different field inlines as well as how to use a range visitor delegate to update all fields in a block tree.
Press the ""Update All Fields"" button to update all fields.
";
}
///
/// Gets the relevant documentation links for the example
///
///
public (string Name, string Url)[] GetDocumentationUrls()
{
return new[]
{
("Rich Text Field Inlines", "https://www.nevron.com/docs/openvision/rich-text-field-inlines.html"),
("Rich Text Inline Elements", "https://www.nevron.com/docs/openvision/rich-text-inline-elements.html"),
};
}
private void PopulateRichText()
{
NSection section = new NSection();
m_RichText.Content.Sections.Add(section);
section.Blocks.Add(GetDescriptionBlock("Field Inlines", "The example shows how to use field inlines.", 1));
section.Blocks.Add(GetNoteBlock("Not all field values are always available. Please check the documentation for more information.", 1));
// add numeric fields
section.Blocks.Add(GetTitleParagraph("Numeric Fields", 2));
ENNumericFieldName[] numericFields = NEnum.GetValues();
string[] numericFieldNames = NEnum.GetNames();
for (int i = 0; i < numericFieldNames.Length; i++)
{
NParagraph paragraph = new NParagraph();
paragraph.Inlines.Add(new NTextInline(numericFieldNames[i] + " ["));
NFieldInline fieldInline = new NFieldInline();
fieldInline.Value = new NNumericFieldValue(numericFields[i]);
fieldInline.Text = "Not Updated";
paragraph.Inlines.Add(fieldInline);
paragraph.Inlines.Add(new NTextInline("]"));
section.Blocks.Add(paragraph);
}
// add date time fields
section.Blocks.Add(GetTitleParagraph("Date/Time Fields", 2));
ENDateTimeFieldName[] dateTimeFields = NEnum.GetValues();
string[] dateTimecFieldNames = NEnum.GetNames();
for (int i = 0; i < dateTimecFieldNames.Length; i++)
{
NParagraph paragraph = new NParagraph();
paragraph.Inlines.Add(new NTextInline(dateTimecFieldNames[i] + " ["));
NFieldInline fieldInline = new NFieldInline();
fieldInline.Value = new NDateTimeFieldValue(dateTimeFields[i]);
fieldInline.Text = "Not Updated";
paragraph.Inlines.Add(fieldInline);
paragraph.Inlines.Add(new NTextInline("]"));
section.Blocks.Add(paragraph);
}
// add string fields
section.Blocks.Add(GetTitleParagraph("String Fields", 2));
ENStringFieldName[] stringFields = NEnum.GetValues();
string[] stringcFieldNames = NEnum.GetNames();
for (int i = 0; i < stringcFieldNames.Length; i++)
{
NParagraph paragraph = new NParagraph();
paragraph.Inlines.Add(new NTextInline(stringcFieldNames[i] + " ["));
NFieldInline fieldInline = new NFieldInline();
fieldInline.Value = new NStringFieldValue(stringFields[i]);
fieldInline.Text = "Not Updated";
paragraph.Inlines.Add(fieldInline);
paragraph.Inlines.Add(new NTextInline("]"));
section.Blocks.Add(paragraph);
}
}
#endregion
#region Implementation
#endregion
#region Event Handlers
///
///
///
///
void OnUpdateAllFieldsButtonClick(NEventArgs arg)
{
m_RichText.Content.VisitRanges(delegate(NRangeTextElement range)
{
NFieldInline field = range as NFieldInline;
if (field != null)
{
field.Update();
}
});
}
#endregion
#region Fields
private NRichTextView m_RichText;
#endregion
#region Static Methods
private static NParagraph GetDescriptionParagraph(string text)
{
return new NParagraph(text);
}
private static NParagraph GetTitleParagraphNoBorder(string text, int level)
{
double fontSize = 10;
ENFontStyle fontStyle = ENFontStyle.Regular;
switch (level)
{
case 1:
fontSize = 16;
fontStyle = ENFontStyle.Bold;
break;
case 2:
fontSize = 10;
fontStyle = ENFontStyle.Bold;
break;
}
NParagraph paragraph = new NParagraph();
paragraph.HorizontalAlignment = ENAlign.Left;
paragraph.FontSize = fontSize;
paragraph.FontStyle = fontStyle;
NTextInline textInline = new NTextInline(text);
textInline.FontStyle = fontStyle;
textInline.FontSize = fontSize;
paragraph.Inlines.Add(textInline);
return paragraph;
}
///
/// Gets a paragraph with title formatting
///
///
///
private static NParagraph GetTitleParagraph(string text, int level)
{
NColor color = NColor.Black;
NParagraph paragraph = GetTitleParagraphNoBorder(text, level);
paragraph.HorizontalAlignment = ENAlign.Left;
paragraph.Border = CreateLeftTagBorder(color);
paragraph.BorderThickness = defaultBorderThickness;
return paragraph;
}
private static NGroupBlock GetNoteBlock(string text, int level)
{
NColor color = NColor.Red;
NParagraph paragraph = GetTitleParagraphNoBorder("Note", level);
NGroupBlock groupBlock = new NGroupBlock();
groupBlock.ClearMode = ENClearMode.All;
groupBlock.Blocks.Add(paragraph);
groupBlock.Blocks.Add(GetDescriptionParagraph(text));
groupBlock.Border = CreateLeftTagBorder(color);
groupBlock.BorderThickness = defaultBorderThickness;
return groupBlock;
}
private static NGroupBlock GetDescriptionBlock(string title, string description, int level)
{
NColor color = NColor.Black;
NParagraph paragraph = GetTitleParagraphNoBorder(title, level);
NGroupBlock groupBlock = new NGroupBlock();
groupBlock.ClearMode = ENClearMode.All;
groupBlock.Blocks.Add(paragraph);
groupBlock.Blocks.Add(GetDescriptionParagraph(description));
groupBlock.Border = CreateLeftTagBorder(color);
groupBlock.BorderThickness = defaultBorderThickness;
return groupBlock;
}
///
/// Creates a left tag border with the specified border
///
///
///
private static NBorder CreateLeftTagBorder(NColor color)
{
NBorder border = new NBorder();
border.LeftSide = new NBorderSide();
border.LeftSide.Fill = new NColorFill(color);
return border;
}
#endregion
#region Constants
private static readonly NMargins defaultBorderThickness = new NMargins(5.0, 0.0, 0.0, 0.0);
#endregion
#region Nested Types
#endregion
}
} | Language: VB.NET |
Imports Nevron.Nov
Imports Nevron.Nov.Dom
Imports Nevron.Nov.Graphics
Imports Nevron.Nov.Layout
Imports Nevron.Nov.Text
Imports Nevron.Nov.UI
Imports Nevron.Nov.Windows.Wpf
Class MainWindow
#Region "Constructors"
Public Sub New()
' This call is required by the designer.
InitializeComponent()
' Add any initialization after the InitializeComponent() call.
' Set form title
Title = "NOV WPF - NFieldInlinesExample"
' Create the NOV example and its controls
Dim exampleContent As NWidget = CreateExampleContent()
Dim exampleControls As NWidget = CreateExampleControls()
If Not exampleControls Is Nothing Then
exampleControls.PreferredWidth = 300
End If
' Place the example and its controls in a pair box
Dim pairBox As NPairBox = New NPairBox(exampleContent, exampleControls)
pairBox.FillMode = ENStackFillMode.First
pairBox.FitMode = ENStackFitMode.First
pairBox.Margins = New NMargins(NDesign.HorizontalSpacing, NDesign.VerticalSpacing)
' Host the example in the form
Dim host As NNovWidgetHost(Of NWidget) = New NNovWidgetHost(Of NWidget)(pairBox)
Content = host
End Sub
#End Region
#Region "Example"
Public Function CreateExampleContent() As NWidget
' Create the rich text
Dim richTextWithRibbon As NRichTextViewWithRibbon = New NRichTextViewWithRibbon()
m_RichText = richTextWithRibbon.View
m_RichText.AcceptsTab = True
m_RichText.Content.Sections.Clear()
' Populate the rich text
PopulateRichText()
Return richTextWithRibbon
End Function
Public Function CreateExampleControls() As NWidget
Dim stack As NStackPanel = New NStackPanel()
Dim updateAllFieldsButton As NButton = New NButton("Update All Fields")
updateAllFieldsButton.Click += AddressOf OnUpdateAllFieldsButtonClick
stack.Add(updateAllFieldsButton)
Return stack
End Function
Public Function GetExampleDescription() As String
Return "
This example demonstrates how to add different field inlines as well as how to use a range visitor delegate to update all fields in a block tree.
Press the ""Update All Fields"" button to update all fields.
"
End Function
'''
''' Gets the relevant documentation links for the example
'''
'''
Public Function GetDocumentationUrls() As (String, String)()
Return {("Rich Text Field Inlines", "https://www.nevron.com/docs/openvision/rich-text-field-inlines.html"), ("Rich Text Inline Elements", "https://www.nevron.com/docs/openvision/rich-text-inline-elements.html")}
End Function
Private Sub PopulateRichText()
Dim section As NSection = New NSection()
m_RichText.Content.Sections.Add(section)
section.Blocks.Add(GetDescriptionBlock("Field Inlines", "The example shows how to use field inlines.", 1))
section.Blocks.Add(GetNoteBlock("Not all field values are always available. Please check the documentation for more information.", 1))
' add numeric fields
section.Blocks.Add(GetTitleParagraph("Numeric Fields", 2))
Dim numericFields As ENNumericFieldName() = NEnum.GetValues(Of ENNumericFieldName)()
Dim numericFieldNames As String() = NEnum.GetNames(Of ENNumericFieldName)()
For i = 0 To numericFieldNames.Length - 1
Dim paragraph As NParagraph = New NParagraph()
paragraph.Inlines.Add(New NTextInline(numericFieldNames(i) & " ["))
Dim fieldInline As NFieldInline = New NFieldInline()
fieldInline.Value = New NNumericFieldValue(numericFields(i))
fieldInline.Text = "Not Updated"
paragraph.Inlines.Add(fieldInline)
paragraph.Inlines.Add(New NTextInline("]"))
section.Blocks.Add(paragraph)
Next
' add date time fields
section.Blocks.Add(GetTitleParagraph("Date/Time Fields", 2))
Dim dateTimeFields As ENDateTimeFieldName() = NEnum.GetValues(Of ENDateTimeFieldName)()
Dim dateTimecFieldNames As String() = NEnum.GetNames(Of ENDateTimeFieldName)()
For i = 0 To dateTimecFieldNames.Length - 1
Dim paragraph As NParagraph = New NParagraph()
paragraph.Inlines.Add(New NTextInline(dateTimecFieldNames(i) & " ["))
Dim fieldInline As NFieldInline = New NFieldInline()
fieldInline.Value = New NDateTimeFieldValue(dateTimeFields(i))
fieldInline.Text = "Not Updated"
paragraph.Inlines.Add(fieldInline)
paragraph.Inlines.Add(New NTextInline("]"))
section.Blocks.Add(paragraph)
Next
' add string fields
section.Blocks.Add(GetTitleParagraph("String Fields", 2))
Dim stringFields As ENStringFieldName() = NEnum.GetValues(Of ENStringFieldName)()
Dim stringcFieldNames As String() = NEnum.GetNames(Of ENStringFieldName)()
For i = 0 To stringcFieldNames.Length - 1
Dim paragraph As NParagraph = New NParagraph()
paragraph.Inlines.Add(New NTextInline(stringcFieldNames(i) & " ["))
Dim fieldInline As NFieldInline = New NFieldInline()
fieldInline.Value = New NStringFieldValue(stringFields(i))
fieldInline.Text = "Not Updated"
paragraph.Inlines.Add(fieldInline)
paragraph.Inlines.Add(New NTextInline("]"))
section.Blocks.Add(paragraph)
Next
End Sub
#End Region
#Region "Implementation"
#End Region
#Region "Event Handlers"
'''
'''
'''
'''
Private Sub OnUpdateAllFieldsButtonClick(arg As NEventArgs)
m_RichText.Content.VisitRanges(Sub(range As NRangeTextElement)
Dim field As NFieldInline = TryCast(range, NFieldInline)
If field IsNot Nothing Then
field.Update()
End If
End Sub)
End Sub
#End Region
#Region "Fields"
Private m_RichText As NRichTextView
#End Region
#Region "Static Methods"
Private Shared Function GetDescriptionParagraph(text As String) As NParagraph
Return New NParagraph(text)
End Function
Private Shared Function GetTitleParagraphNoBorder(text As String, level As Integer) As NParagraph
Dim fontSize As Double = 10
Dim fontStyle = ENFontStyle.Regular
Select Case level
Case 1
fontSize = 16
fontStyle = ENFontStyle.Bold
Case 2
fontSize = 10
fontStyle = ENFontStyle.Bold
End Select
Dim paragraph As NParagraph = New NParagraph()
paragraph.HorizontalAlignment = ENAlign.Left
paragraph.FontSize = fontSize
paragraph.FontStyle = fontStyle
Dim textInline As NTextInline = New NTextInline(text)
textInline.FontStyle = fontStyle
textInline.FontSize = fontSize
paragraph.Inlines.Add(textInline)
Return paragraph
End Function
'''
''' Gets a paragraph with title formatting
'''
'''
'''
Private Shared Function GetTitleParagraph(text As String, level As Integer) As NParagraph
Dim color = NColor.Black
Dim paragraph = GetTitleParagraphNoBorder(text, level)
paragraph.HorizontalAlignment = ENAlign.Left
paragraph.Border = CreateLeftTagBorder(color)
paragraph.BorderThickness = defaultBorderThickness
Return paragraph
End Function
Private Shared Function GetNoteBlock(text As String, level As Integer) As NGroupBlock
Dim color = NColor.Red
Dim paragraph = GetTitleParagraphNoBorder("Note", level)
Dim groupBlock As NGroupBlock = New NGroupBlock()
groupBlock.ClearMode = ENClearMode.All
groupBlock.Blocks.Add(paragraph)
groupBlock.Blocks.Add(GetDescriptionParagraph(text))
groupBlock.Border = CreateLeftTagBorder(color)
groupBlock.BorderThickness = defaultBorderThickness
Return groupBlock
End Function
Private Shared Function GetDescriptionBlock(title As String, description As String, level As Integer) As NGroupBlock
Dim color = NColor.Black
Dim paragraph = GetTitleParagraphNoBorder(title, level)
Dim groupBlock As NGroupBlock = New NGroupBlock()
groupBlock.ClearMode = ENClearMode.All
groupBlock.Blocks.Add(paragraph)
groupBlock.Blocks.Add(GetDescriptionParagraph(description))
groupBlock.Border = CreateLeftTagBorder(color)
groupBlock.BorderThickness = defaultBorderThickness
Return groupBlock
End Function
'''
''' Creates a left tag border with the specified border
'''
'''
'''
Private Shared Function CreateLeftTagBorder(color As NColor) As NBorder
Dim border As NBorder = New NBorder()
border.LeftSide = New NBorderSide()
border.LeftSide.Fill = New NColorFill(color)
Return border
End Function
#End Region
#Region "Constants"
Private Shared ReadOnly defaultBorderThickness As NMargins = New NMargins(5.0, 0.0, 0.0, 0.0)
#End Region
#Region "Nested Types"
#End Region
End Class