This project consists of a TextBoxComponent, Multiline TextBox, CheckBox, ComboBox,
CheckedListComboBox, CheckedListBox, Grid, Label, Calendar Component, Time Component
and more.
The CSS file DataJuggler.Blazor.Components.css contains many useful classes to help style
and position objects.
This version is for .NET 9.0.
Make sure your code file has a Properties region, and select one or more private variables - Click the
Create Properties button
A property is created
#region InfoBox
/// <summary>
/// This property gets or sets the value for 'InfoBox'.
/// </summary>
public InformationBox InfoBox
{
get { return infoBox; }
set { infoBox = value; }
}
#endregion
To create a HasProperty, I select the word InfoBox, in the line public InformationBox InfoBox
and in Regionizer 2022, I click 'Create Has Property'.
This creates a read only property that is a simple method of testing for null
#region HasInfoBox
/// <summary>
/// This property returns true if this object has an 'InfoBox'.
/// </summary>
public bool HasInfoBox
{
get
{
// initial value
bool hasInfoBox = (this.InfoBox != null);
// return value
return hasInfoBox;
}
}
#endregion
<img src="https://github.com/DataJuggler/DataJuggler.Blazor.Components/blob/master/wwwroot/Images/RedProgressBase.png">
Then in the Register method of the page or component hosting the InformationBox, make sure the
component implements IBlazorComponentParent. If you have more than one InformationBox on a page
or component, you can refer to them by name to store each component. The example below only has
one InformationBox on the page.
In the register method, store the object
if (component is InformationBox)
{
// Store
InfoBox = component as InformationBox;
// test only
List<Item> items = CreateSampleInfoBoxItems();
// if the value for HasInfoBox is true
if (HasInfoBox)
{
// Set the Items
InfoBox.SetItems(items);
// Update the UI
InfoBox.Refresh();
}
}
And this method CreateSampleInfoBoxItems demonstrates how to load a list of items
Tip: Notice the code for the image for the first item. You can place an image on the left or right of text,
by selecting the ImageAlignment.
#region CreateSampleInfoBoxItems()
/// <summary>
/// returns a list of Sample Info Box Items
/// </summary>
public List<Item> CreateSampleInfoBoxItems()
{
// initial value
List<Item> items = new List<Item>();
// Create a new instance of an 'Item' object.
Item item = new Item();
item.Caption = "Acceptable Pressure Test?";
item.Text = "Yes";
// image
item.IncludeImage = true;
item.ImageAlignment = ImageAlignmentEnum.ImageOnLeftOfText;
item.ImageWidth = 16;
item.ImageHeight = 16;
item.ImageUrl = "../Images/GreenCircle.png";
// Add this item
items.Add(item);
// Create a new instance of an 'Item' object.
item = new Item();
item.Caption = "PSI Loss to Leak?";
item.Text = "30.1 psi";
// Add this item
items.Add(item);
// Create a new instance of an 'Item' object.
item = new Item();
item.Caption = "Total Test Time";
item.Text = "8 Hours 0 Minutes";
// Add this item
items.Add(item);
// Create a new instance of an 'Item' object.
item = new Item();
item.Caption = "Min Test Duration Met?";
item.Text = "Yes";
// Add this item
items.Add(item);
// Create a new instance of an 'Item' object.
item = new Item();
item.Caption = "Min Test Pressure Met?";
item.Text = "Yes";
// Add this item
items.Add(item);
// Create a new instance of an 'Item' object.
item = new Item();
item.Caption = "MAOP Verified By Test";
item.Text = "452 psi";
// Add this item
items.Add(item);
// Create a new instance of an 'Item' object.
item = new Item();
item.Caption = "Desired MAOP";
item.Text = "400 psi";
// Add this item
items.Add(item);
// Create a new instance of an 'Item' object.
item = new Item();
item.Caption = "Test Within Pressure Bounds?";
item.Text = "Yes";
// Add this item
items.Add(item);
// return value
return items;
}
#endregion
5.24.2024
8.8.8: New Properties were added to the ComboBox to control the height of the TextBox for the CalendarComponent
5.8.2024: I spent a week refactoring the Combo Box. I realized my first combobox wasn't a standard combobox.
Now, if you are in regular mode (not checklist mode), you can type T twice for Texas in a States list, for example.
I have a new sample project called 'NTouch', that demonstrates the ComboBox and the Calendar.
Notice the attribute Parent=this on Line 2. This is how the ComboBox registers with its parent. To use this feature, you probably
have to supress the warning BL0007 in the project properties. Microsoft doesn't like code in Setters, but this is how all
IBlazorComponents and IBlazorComponentParents talk to each other.
New video coming soon.
Here is the css you must put in the client project that uses the ComboBox. Notice line 3 DropDownClassName
Feel free to adjust the height and width as needed. The position absolute is the key to the Drop Down showing, without
moving other content (spent a while on this). Border1Gray is shown below.
It is important to note the CheckedListClassName on line 3. I have two CSS classes set in an External project, that are the key
to making the Z-Index work. I tried using an internal CSS Class, and haven't had much luck. Will try again later.
5.1.2024: I added a ZIndex property to the Calendar. If you have two calendar components near each other, the first one can't type.
Will work on a solution later, but the ZIndex should allow a fix.
4.30.2024: Version 8.6.22 fixes the textbox and button jumping around when the calendar showed, by adding min-height and max-height
properties to the ContainerStyle BlazorStyled class.
4.29.2024: I added few more tweaks to the CalendarComponent, to make it easier to use.
I think a good future feature might be if you click on the Year label, a combobox opens with a selection of years.
For things like Birthday, scrolling dozens of years isn't worth it. You can always type it, but a year selector might
be worth exploring.
4.27.2024: Eureka! I have done it. I built a working CalendarComponent, and being it has been tested by all of 1 person in all
of 1 project(s), I am pretty excited. If this doesn't make it worth the price, and make you willing to leave a star on GitHub
or Subscribe to my YouTube channel, nothing will.
4.24.2024: To celebrate the coming milestone of 200,000 installs coming up this summer, I am working on a Calendar Component.
The Calendar Component is in this release (8.5.0), but it is far from being to use. What I am testing now is the text box shows up,
the button shows up, and if you click the button, the pop up calendar div shows and goes away as you toggle the button.
Soon I will add buttons for the calendar. Baby steps.
4.23.2024: I had some problems running the Blazor Server App projects in .NET 8. The problem was browsers (Chrome) are depreciating
Page Unload events, and blazor.server.js is the culprit. I switched to a web app and things work.
The one important thing I noticed, linking to a CSS class like this seems to not work in a Blazor Web Project (not Blazor Server App Template)
4.18.2024: The conversion to using BlazorStyled again has completed. Testing in progress, but seems to work.
4.17.2024: I added back BlazorStyled, but I forked the project and created a NuGet package DataJuggler.BlazorStyled.
I didn't make any code changes, all I did was upgrade the component to .NET 8 and the dependencies.
4.8.2024: I modified the grid with a new property 'NotifyParentOnDoubleClick'. You can set
an ExternalId and ExternalIdDescription when you create the rows.
I also added an EnableClick function for a Grid row. The Click does work. Testing the DoubleClick now.
the parent object will receive a message. Optionally, Set the ExternalId and ExternalId Description.
4.5.2024: ImageButton does not have a ClassName property.
4.4.2024: I removed the dependency on Blazor Styled. Blazor Styled hasn't been updated since
.NET Core 3.1, and I found you can create a Style section on any razor page and do the same thing
without Blazor Styled, and with better results it seems of late.
12.30.2023: I updated the CheckBox to send a message to its Parent when it's value changes.
I added SetLabelColor method to the ValidationComponent.
Version 7.13.5
Novermber 7, 2023: DataJuggler.Blazor.Components passed 100,000 Downloads
I updated the Grid and created a new sample project to demo the Grid.
Version 7.12.8
November 2, 2023: I added a ClassName parameter to the Grid
August 29, 2023:
New Video: DataJuggler.Blazor.Components reaches 75,000 Installs
https://youtu.be/WkcwQ9kOfw4
In this short video I show a demo of code generating classes from Blazor Excelerate.
August 26, 2023: In celebration of 75,000 NuGet installs, I added two new features.
First, I created a CheckedListBox component. I also added a new feature to the ComboBox,
and that new features is a CheckedListMode. The combobox now supports check boxes and
multiple selections.
July 22, 2023: More updates to NuGet package DataJuggler.Excelerate, and I need this update for my project
Blazor Excelerate
July 21, 2023: I updated NuGet package DataJuggler.Excelerate, and I need this update for my project
Blazor Excelerate
July 18, 2023: I fixed the checkbox component. The binding wasn't working when I thought I fixed it last time.
July 9, 2023: I removed floats from the ComboBox component. I was having trouble "stacking" a ValidationComponent
below a ComboBox, so hopefully this fixes it. I also added a ComboBoxWidth parameter property on the ComboBox.
July 6, 2023: I added an AutoComplete property, which defaults to false.
The reason for this is browsers like to fill in values, and the browser is confusing Email Address and User Name fields.
July 2, 2023: I removed the floats from the ValidationComponent. This will probably break
some existing users, but I am trying to make the control more consistant to work with.
I also added a MarginBottom property. Use this in conjunction with the HeightUnit, which
defaults to px (pixels) and the MarginBottom is set to 8 by default.
June 21, 2023: I updated DataJuggler.UltimateHelper.
June 3, 2023 B: I updated the Sprite component to have a SetVisible and optional parameter for Hide
when you call Stop.
June 3, 2023: My first attempt at Disabled for the Validation Component was wrong. I think my fix will work. Testing now.
June 2, 2023: I added an Enabled property and a method SetEnabled to the validation component.
If Enabled is false, disabled will appear in the input objects and be read only.
This project has a dependency on DataJuggler.BlazorStyled (a port of BlazorStyled by chanan. Both will work, but
the forked version has been upgraded for .NET8.)
BuildCopy will copy the files from a Visual Studio solution to an output folder. In this case, the output folder is ProjectTemplates\Working\Templates. BuildCopy also allows you to set ignore folders, so I do not copy the .vs, .git, .bin, .obj, .templateconfig and a few others.
Here is a video showing you how to setup this project, build the data tier for Blazor Gallery, and build your own DataTier.Net projects.
Want To Help Contribute to this project?
Volunteer to take the instructions from the video and write them out as step by step. Bonus with images and screen shots.
If you think this project is worth the price, please leave a star and / or subscribe to my YouTube channel: https://youtube.com/DataJuggler
Thanks
One of my favorite parts of this project is the DataJuggler.Blazor.Componets.css file.
After adding nuget package DataJuggler.Blazor.Componets Nuget package, add the folloing line to
your _layout.cshtml file in your Blazor project:
This componet can serve as a CheckBox, a TextBox or a TextArea.
Register the componet by setting the parent=this, and your parent needs to implement
IBlazorComponentParent interface.
Add the following line in your parent component.
using DataJuggler.Blazer.Components.Interfaces;
Tip: Use partial classes for your components. To do this, in your project add a CS class with the same name
as your component. Name your class such as this:
Example:
Grid.razor
Grid.razor.cs (partial class)
public partial class Grid : ComponentBase, IBlazorComponent, IBlazorComponentParent
As you can see above, the Grid implements IBlazorComponet and IBlazorComponentParent.
Visual Studio makes it easy to implement interfaces. Right click the interface name, and select
Quick Actions and Refactoring > Implement Interface.
This will stub out the properties and methods needed to implement the interface.
To see an example of registering components, see the project Blazor Excelerate linked
at the top of this document. Look for a method called Register. Once registered then your
components can talk to each other using the ReceiveData method and by passing Message objects.
Update 11.7.2023: I just published a new project to Demo Grids
Notice the property Parent="this" on the bottom line. This is how the grid is registered with the parent.
View the code for the BubbleReportWeb above, and view the code for Index.razor.cs. The Register method has multiple grid properties.
private Grid topStreakGrid;
/// <summary>
/// This property gets or sets the value for 'TopStreakGrid'.
/// </summary>
public Grid TopStreakGrid
{
get { return topStreakGrid; }
set { topStreakGrid = value; }
}
One important thing to note, is the grid works best when you register DataJuggler.Blazor.Components.css in your project like this:
Removing the tilde seems necessary for Blazor Web Apps (latest .NET8 Template). I will do more testing when I get a chance and confirm this works in both.
The above CSS class is included with NuGet package DataJuggler.Blazor.Components
The grid can be loaded via code in the OnAfterRenderAsync event:
protected async override Task OnAfterRenderAsync(bool firstRender)
{
// if the TopStreakGrid exists
if (HasTopStreakGrid)
{
// create the rows
List<Row> rows = CreateRowsForTopStreakStocks();
// Set the Row
TopStreakGrid.Rows = rows;
// Refresh the Grid
TopStreakGrid.Refresh();
}
}
Loading Grid Rows and Columns
In this example, I added two using statements to avoid the conflict between DataJuggler.Excelerate.Row and DataJuggler.Excelerate.Column
OfficeOpenXml.Row and OfficeOpenXml.Column. DataJuggler.Blazor.Excelerate is installed when you add DataJuggler.Blazor.Components
to a project via NuGet.
Note: The Gateway class listed below is created when you create a project via DataTier.Net. You can use EntityFramework or another ORM
if you prefer. I like DataTier.Net because it uses all stored procedures.
This class consists of an ImageButton, ProgressBar, Sprite, ValidationComponent, ComboBox,
CheckedListBox and a Grid.
CheckedListBox
Update 8.26.2023: If you need to hide the CheckedListBox, before hiding you need to store
the selections. Look at the code for the ComboBox.ButtonClickedEvent to see an example where
it calls StoreSelections. This checks the Items in memory if the checkboxes have been checked.
I have tried doing this dynamically as the items are checked, and had numeroius problems.
Update 11.8.2022: This project has been updated to .NET 7.
DataJuggler.Excelerate has been added to add Rows and Columns for the Grid.
The hosting page or component must implement the IProgressSubscriber interface.
Implementing IProgressSubscriber Interface
This interface contains two simple methods and one property.
public partial class Index : IProgressSubscriber
{
...
}
IProgressSubscriber Interface Methods
Refresh
/// <summary>
/// This method is called by the ProgressBar when as it refreshes.
/// </summary>
public void Refresh(string message)
{
// Update the UI
InvokeAsync(() =>
{
StateHasChanged();
});
}
Register
/// <summary>
/// This method Registers the ProgressBar with this app.
/// </summary>
public void Register(ProgressBar progressBar)
{
// store the ProgressBar
this.ProgressBar = progressBar;
}
Blazor Styled Has Been Removed
Use Cases
For now, the progress bar is meant to show the user something is happening during a long running process.
The sample project demonstrates using a Timer and on every refresh the progress bar increases the fill width by the increment value
in pixels, up to the Max value. To use the timer, call the Start method on the Progress bar.
In theory, and I will update this once I know it works, you should also be able to manually increase the FillWidth value, which in turn sets the FillWidthPixels string value
Example: FillWidth = 100
FillWidthPixels = 100px
The FillWidthPixels is used by the CSS for the inner graph.
This is the Tick event the Timer calls on every cycle. This method increments the FillWidth by the Increment value.
If the value for Max is encountered, either the app will close if HideWhenFinished is true or reset if continuous is true.
ProgressBar Methods
Init
This method is called by the Constructor of the ProgressBar and sets the DefaultValues.
Start
Call this method to Start the timer. This is used where the graph increments on a regular basis based upon the interval set.
public void Start(int startAtValue = 0)
Stop
This method stops the timer and all future events (already in progress events may finish before stopping)
ProgressBar Properties
CurrentValue
[Parameter]
public int CurrentValue { get; set; }
The CurrentValue also sets the FillWidth. This property might be removed as FillWidth controls FillWidthPixels, and is what the display goes by.
Display
public string Display { get; set; }
The display is managed by the ProgressBar.Visible property, but you can change it if needed (I think).
The FillWidth is the number of pixels displayed up to the Max value.
Setting the FillWidth sets the FillWidthPixels CSS Property.
FillWidth = 90;
FillWidthPixels = 90px
FillWidthPixels
public int FillWidthPixeels { get; set; }
As described above, a property that is the CSS value for how many pixels to display.
Set this property by setting the FilWidth integer value else you are in uncharted waters.
HasSubscriber
public bool HasSubscriber { get; }
This read only property returns true if the ProgressBar has a Subscriber.
Increment
[Parameter]
public bool Increment { get; set; }
This value sets how many pixels left the next bubble will be.
This value is set by the Increment times the number of times Refresh was called.
Interval
[Parameter]
public int Interval { get; set; }
This is the value in milliseconds for how often the Timer event will fire. The default value is 100 if not set.
Max
[Parameter]
public int Max { get; set; }
This is the maximum value the ProgressBar inner fill can go to.
The Default Value is 552.
NotificationInProgress
public bool NotificationInProgress { get; set; }
This property is used internally by the ProgressBar to make sure only one thread of notifications is sent to the Client at a time.
This is also useful for debugging as it keeps the message chain down to single threads.
Position
public string Position { get; set; }
This property is set on the CSS Class for position. Fixed, Absolute and Relative are the 3 I know, there may be more.
ProgressBackground
public string ProgressBackground { get; set; }
This is the string property bound to the CSS styles for the ProgressBar div.
In future versions I imagine themes or other styles, or even an option to display the innter graph without the background.
Scale
I added a double value for Scale that allows to control how big the ProgressBar displays. The default is .5.
Started
public bool Started { get; set; }
This property is managed internally the by the ProgressBar when Start and Stop are called.
Subscriber
[Parameter]
public IProgressSubscriber Subscriber
This property registers the parent with the ProgressBar, which enables the ProgressBar to register with the host.
<ProgressBar Subscriber=this></ProgressBar>
Timer
public Timer Timer { get; set; }
The System.Timer Timer that is started when the Start method is called.
Visible
[Parameter]
public bool Visible { get; set; }
This property sets the @Display value to either inline-block if true (visible), or none if false (invisible).
Sprite Component
I created a new Sprite component that allows you to set properties for images.
Sprite Methods
# Init
The Init method sets the Default values for the control
# Start
The Start method starts the Timer and sets the Elapsed event.
# Stop
Stops the timer and future messages.
I have another project planned for Animation called DataJuggler.Blazor.Animation. In that class I have speced out an AnimationManager in my mind, but for now I only create a Timer on one Sprite, and I use the Refresh messages to move Sprites around.
Eventually I would like this to be more automated where you give it a Start X,Y and an End X,Y position and a path could be firued out, but baby steps.
Sprite Properties
Many of the properties are identical to the ProgressBar, only the differences are listed here.
Height
[Parameter]
public int Height { get; set; }
The height in pixels.
HeightPixels
public string HeightPixels { get; set; }
This value is set by the setter for Height. The string px is appended to the end.
Example: Height: 80
HeightPixels: 80px.
ImageUrl
[Parameter]
public string ImageUrl
This value is set as the background image for the Div.
Name
[Parameter]
public string Name
The name helps distinquish Sprites from other Sprites.
Width
[Parameter]
public int Width { get; set; }
This property sets the WidthPixels property, which in turns sets the Width of the component.
WidthPixels
public string WidthPixels { get; set; }
This value is set when you set the Width property.
