Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wongjiahau/displaying-xaml
This library is for display the XAML code of theme library for WPF (e.g. MaterialDesignInXamlToolkit)
https://github.com/wongjiahau/displaying-xaml
code-display demo theme-library wpf xaml
Last synced: 3 months ago
JSON representation
This library is for display the XAML code of theme library for WPF (e.g. MaterialDesignInXamlToolkit)
- Host: GitHub
- URL: https://github.com/wongjiahau/displaying-xaml
- Owner: wongjiahau
- License: gpl-3.0
- Created: 2017-07-27T06:41:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-11-12T09:21:39.000Z (about 7 years ago)
- Last Synced: 2024-11-02T01:50:15.504Z (3 months ago)
- Topics: code-display, demo, theme-library, wpf, xaml
- Language: C#
- Homepage:
- Size: 518 KB
- Stars: 39
- Watchers: 8
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Displaying-XAML
This library is for display the XAML code of theme library for WPF (e.g. MaterialDesignInXamlToolkit/MahApps)
## Why is this library written ?
Because the demo app for the theme library I'm using ([MaterialDesignInXamlToolkit](https://github.com/ButchersBoy/MaterialDesignInXamlToolkit)) is too hard to use.
For example, when I want to use a control in the demo, I have to search through its GitHub repo for the code. Obviously, this is a pain, therefore I wrote this library, so that the code can be displayed besides each control.
## Demo
## How to use this library ?
### 1. Install from nuget
`Install-Package XamlDisplayerPackage -Version 1.0.3 `
### 2. Call the XamlDisplayerPanel initializer at the app startup
```C#
private void App_OnStartup(object sender, StartupEventArgs e) {
XamlDisplayerPanel.Initialize(
source:
XamlDisplayerPanel.SourceEnum.LoadFromLocal ,
defaultLocalPath:
@"C:\Users\User\Source\Repos\Displaying-XAML\XamlDisplayer\Demo\" ,
defaultRemotePath:
"https://raw.githubusercontent.com/wongjiahau/Displaying-XAML/master/XamlDisplayer/Demo/" ,
attributesToBeRemoved:
new List()
{
"xmlns=\"http://schemas.microsoft.com/winfx/2006/xaml/presentation\"" ,
"xmlns:materialDesign=\"http://materialdesigninxaml.net/winfx/xaml/themes\"" ,
"xmlns:x=\"http://schemas.microsoft.com/winfx/2006/xaml\""
}
);
}
```
- `source` determine where you want to load the XAML source file (either from local(your computer) or remote(e.g. GitHub)
- `defaultLocalPath` determine where the files shall be loaded by default if you set `source` as `LoadFromLocal`
- `defaultRemotePath` determine where the files shall be loaded by default if you set `source` as `LoadFromRemote`
- `attributesToBeRemoved` specifies the attributes that should be filetered out when displaying the code for each control
_Refer [here](https://msdn.microsoft.com/en-us/library/system.windows.application.startup(v=vs.110).aspx) to learn more about App_OnStartup method_
### 3. At the place where all the pages are hosted (usually MainWindow.xaml), place in the XamlDisplayerHost
```xml
```
The XamlDisplayerHost is actually a Frame, so you can call the `Navigate` method using it.
### 4. For each of the page that is going to be navigated, surround all the controls with XamlDisplayerPanel
```xml
```
_Note : The XamlDisplayerPanel can be placed on any level of depth_
### 5. Navigate to each pages by calling Navigate method of XamlDisplayerHost
```C#
public MainWindow() {
InitializeComponent();
XamlDisplayerHost.Navigate(new Page1());
}
```
_Actually, you can also use binding to bind its `Content`, because `XamlDisplayerHost` is inherited directly from `Frame`_