European Sharepoint 2013 Hosting Blog
Articles about European Sharepoint Hosting Service
SharePoint 2013 Hosting – HostForLIFE.eu :: How to Get all Terms from the TermStore in SharePoint Using C#?
Jan 10th
This post shows how to retrieve all the Terms from the Term Store in SharePoint Using C#. We are fetching a custom Term Set from a Custom Group.
Code:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
using (SPSite RootSite = new SPSite(SPContext.Current.Site.Url)) { using (SPWeb RootWeb = RootSite.OpenWeb()) { TaxonomySession TaxonomySession = new TaxonomySession(RootSite); TermStore termstore = TaxonomySession.TermStores["Managed Metadata Service"]; Group group = termstore.Groups["CustomGroup"]; TermSet termset = group.TermSets["CustomTermset"]; TermCollection termcoll = termset.GetAllTerms(); StringBuilder strbl = new StringBuilder(); foreach (Term term in termcoll) { strbl.Append(term.Name.ToString()); } Literal1.Text = strbl.ToString(); } } |
SharePoint 2013 Hosting – HostForLIFE.eu :: Office UI Fabric Choice Group Integration in SharePoint Framework (SPFx)
Dec 19th
In this blog, we will learn how to integrate an Office UI Fabric ChoiceGroup control in the SharePoint Framework (SPFx).
The ChoiceGroup component, also known as radio buttons, lets users select one option from two or more choices. Each option is represented by one ChoiceGroup button; a user can select only one ChoiceGroup in a button group. The below steps explain how to integrate choice group control in your SPFx solution, and how to store values to state variable on change.
Steps Involved
Install “office-ui-fabric-react” from the node package manager as shown below.
|
1 |
PS C:\XXXX\SPFxSolutions\SpFxRichTextEditor>npm install --save office-ui-fabric-react |
Import “office-ui-fabric-react” to your .tsx file as shown below.
In this blog, I have used class file (ProjectTaskConstants.ts) to hold all the values to be populated in choice group as shown below
ProjectTaskContants.ts
|
1 2 3 4 5 6 7 8 9 10 11 |
import { ChoiceGroup } from 'office-ui-fabric-react'; export default class ProjectTaskConstants{ static get StatusOptions(){ const statusOptions: IChoiceGroupOption[] = [ { key: "Open", text: "Open" }, { key: "Closed", text: "Closed" }, { key: "On hold", text: "On hold" } ]; return statusOptions; } } |
Import ProjectTaskContants.ts file to your .tsx file as shown below
|
1 |
import ProjectTaskConstants from '../ProjectTaskConstants'; |
Instantiate the class file as shown below:
|
1 2 |
/*This to get all the constant values*/ public Constants = new ProjectTaskConstants(); |
Usage
In Render method, use the control as shown below:
OnChange event:
|
1 2 3 4 5 |
public onStatusChange(ev: React.FormEvent<HTMLInputElement>, option: any): void { this.setState({ Status: option.key }); } |
In the above example, I have used “Status” state variable of type string.
To disable the choice group:
SharePoint 2013 Hosting – HostForLIFE.eu :: New Improvements in SPFx v 1.10
Dec 12th
Hi All, I hope many are aware of the new release of SharePoint Framework v1.10. I have summarized release details in a table for a quick review.
1. Extensions – Pre-allocated placeholders
Issue: Page is pushed down slightly when top header navigation (SPFx extension) is added between suite navigation and the header.
Cause: This is created by the top header extension being injected into the page when the page contents are downloaded.
Fix:
This issue is fixed by locking the area with pre-allocated placeholders(50px) for optimal experience by end-users.
You can control this experience by creating an item from Tenant wide extensions list -> Host properties column.
2. SPFx for Teams – Personal Apps support
Improvements: SPFx Teams tab development started from v1.6. They are added as tabs in the Teams channel. From v1.10 SPFx, the development also involves the Personal Apps in Microsoft Teams based on User context rather than a tab in Teams channel.
Proposed: We can specify this webpart manifest, whether it should be in SharePoint Webpart, Teams Tab, or Personal Tab in Teams.
3. List Notification API
Improvements: Whenever a new item is added to the list, the webpart displays the item dynamically without refreshing.
4. SharePoint Framework for Office – starts with OWA
Improvements: Extend the Outlook experience with SharePoint Framework development. For example, a user can add attachments from a SharePoint Library by creating a simple panel extension. Currently, this works with full support of REST API and Graph API.
5=>Search Suggestions
Improvements: No longer associated as SharePoint Search, it is now Microsoft Search and so it is displayed in Top bar.
Query is passed to Search API and results are displayed based on the word even with translation support.
SharePoint 2013 Hosting – HostForLIFE.eu :: Calling Third Party API in SPFX using @microsoft/sp-http
Dec 5th
In this blog, you will learn about Calling Third Party API in SPFX using @microsoft/sp-http
Steps
Open a command prompt. Create a directory for SPFx solution.
md spfx-React-ThirdPartyApi
Navigate to the above-created directory.
cd spfx-React-ThirdPartyApi
Run the Yeoman SharePoint Generator to create the solution.
yo @microsoft/sharepoint
Solution Name
Hit Enter to have a default name (spfx-React-ThirdPartyApi in this case) or type in any other name for your solution.
Selected choice – Hit Enter
Target for the component
Here, we can select the target environment where we are planning to deploy the client web part, i.e., SharePoint Online or SharePoint OnPremise (SharePoint 2016 onwards).
Selected choice – SharePoint Online only (latest)
Place of files
We may choose to use the same folder or create a subfolder for our solution.
Selected choice – Same folder
Deployment option
Selecting Y will allow the app to be deployed instantly to all sites and be accessible everywhere.
Selected choice – N (install on each site explicitly)
Permissions to access web APIs
Choose if the components in the solution require permission to access web APIs that are unique and not shared with other components in the tenant.
Selected choice: N (solution contains unique permissions)
Type of client-side component to create
We can choose to create a client-side web part or an extension. Choose the web part option.
Selected choice – WebPart
Web part name
Hit Enter to select the default name or type in any other name.
Selected choice – ThirdpartyApi
Web part description
Hit Enter to select the default description or type in any other value.
Framework to use
Select any JavaScript framework to develop the component. Available choices are – No JavaScript Framework, React, and Knockout.
Selected choice – React
Yeoman generator will perform a scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.
Once the scaffolding process is completed, lock down the version of project dependencies by running the below command,
npm shrinkwrap
In the command prompt, type below command to open the solution in the code editor of your choice.
code .
in IThirdpartyApiProps.ts
in ThirdpartyApiWebPart.ts
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
import * as React from 'react'; import * as ReactDom from 'react-dom'; import { Version } from '@microsoft/sp-core-library'; import { BaseClientSideWebPart, IPropertyPaneConfiguration, PropertyPaneTextField } from '@microsoft/sp-webpart-base'; import * as strings from 'ThirdpartyApiWebPartStrings'; import ThirdpartyApi from './components/ThirdpartyApi'; import { IThirdpartyApiProps } from './components/IThirdpartyApiProps'; export interface IThirdpartyApiWebPartProps { description: string; } export default class ThirdpartyApiWebPart extends BaseClientSideWebPart<IThirdpartyApiWebPartProps> { public render(): void { const element: React.ReactElement<IThirdpartyApiProps > = React.createElement( ThirdpartyApi, { description: this.properties.description, myhttpclient:this.context.httpClient } ); ReactDom.render(element, this.domElement); } protected onDispose(): void { ReactDom.unmountComponentAtNode(this.domElement); } protected get dataVersion(): Version { return Version.parse('1.0'); } protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration { return { pages: [ { header: { description: strings.PropertyPaneDescription }, groups: [ { groupName: strings.BasicGroupName, groupFields: [ PropertyPaneTextField('description', { label: strings.DescriptionFieldLabel }) ] } ] } ] }; } } |
in ThirdpartyApi.tsx
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
import * as React from 'react'; import {sp} from '@pnp/sp'; import { IThirdpartyApiProps } from './IThirdpartyApiProps'; import { HttpClient, HttpClientResponse } from '@microsoft/sp-http'; export interface IthirdpartyState { ApiOutput?:any[]; } export default class ThirdpartyApi extends React.Component<IThirdpartyApiProps, IthirdpartyState> { constructor(props: IThirdpartyApiProps, state: IthirdpartyState) { super(props); this.state = { ApiOutput: [] }; } /*async PnpfilePermission(id, arrayId, title){ const list = sp.web.getList(`/sites/site/Lists/List`); const item = list.items.getById(3); /* const folder = sp.web.getFolderByServerRelativePath('Shared%20Documents/some_folder'); const folderItem = await folder.getItem(); const file = sp.web.getFileByServerRelativePath('Shared%20Documents/some_file.docx'); const fileItem = await file.getItem(); */ // Break role inheritence for unique permissions /* await item.breakRoleInheritance(false); // Method receives params // Get user/group proncipal Id const { Id: principalId } = await sp.web.currentUser.select('Id').get(); // Get role definition Id const { Id: roleDefId } = await sp.web.roleDefinitions.getByName('Edit').get(); // Assigning permissions await item.roleAssignments.add(principalId, roleDefId); console.log(`Done`); }*/ public componentDidMount(){ var myoutput = []; this._getthirdpartyApi() .then(response => { myoutput.push(response); this.setState({ ApiOutput: myoutput }); }); } private _getthirdpartyApi(): Promise<any> { return this.props.myhttpclient .get( 'https://jsonplaceholder.typicode.com/photos', HttpClient.configurations.v1 ) .then((response: HttpClientResponse) => { return response.json(); }) .then(jsonResponse => { console.log(jsonResponse); return jsonResponse; }) as Promise<any>; } public render(): React.ReactElement<IThirdpartyApiProps> { return ( <div > { this.state.ApiOutput[0] && <Bindvalue bindoutput={this.state.ApiOutput[0]} />} </div> ); } } const Bindvalue = (props) => { const Bindedcontent = props.bindoutput.map((httpapi,index) => <div key={index}> <span>{httpapi.id}</span><br></br> <span>{httpapi.title}</span><br></br> <span>{httpapi.url}</span><br></br> </div> ); return ( <div> {Bindedcontent} </div> ); }; |
HttpClient Example Configuration
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
import { HttpClient, IHttpClientOptions, HttpClientResponse } from '@microsoft/sp-http'; private makeRequest(value1: string, value2: string, value3: string): Promise<HttpClientResponse> { const postURL = "https://REST-API-URL"; const body: string = JSON.stringify({ 'name1': value1, 'name2': value2, 'name3': value3, }); const requestHeaders: Headers = new Headers(); requestHeaders.append('Content-type', 'application/json'); requestHeaders.append('Cache-Control', 'no-cache'); //For an OAuth token requestHeaders.append('Authorization', 'Bearer <TOKEN>'); //For Basic authentication requestHeaders.append('Authorization', 'Basic <CREDENTIALS>'); const httpClientOptions: IHttpClientOptions = { body: body, headers: requestHeaders }; console.log("About to make REST API request."); return this.context.httpClient.post( postURL, HttpClient.configurations.v1, httpClientOptions) .then((response: Response): Promise<HttpClientResponse> => { console.log("REST API response received."); return response.json(); }); } |
HttpClient api is provided by Microsoft for Crud operations of 3rd party APIs.
SharePoint 2013 Hosting – HostForLIFE.eu :: ReactHooks with Spfx
Nov 14th
Hooks Overview
React Hooks are a way to add React.Component features to functional components. Features include:
- State
- Lifecycle
Hooks let you use React’s features without classes.
What is this useState() syntax?
You may be unfamiliar with the useState() syntax. This uses destructuring assignment for arrays. It is similar to how we would pull props out an object with object destructuring.
What does useState() give us?
useState gives us two variables. We can name our two variables whatever we want, just know that:
- The first variable is the value. Similar to this.state
- The second variable is a function to update that value. Similar to this.setState
- The final part of useState is the argument that we pass to it. The useState argument is the initial state value. In the case of our counter, we started at 0.
What’s wrong with classes?
The React Hooks intro gives a good section on this: Classes confuse both people and machines. Classes can sometimes be confusing and be written in any number of ways. Dive into somebody else’s project and you could be in for a world of different syntax and style choices. Though there are no plans to remove class support. we just have another way to code.
By allowing classes to be converted into smaller functional components, we can further break out parts of our application into more focused components.
React’s Effect Hook
The State Hook allows us to use state in React functional components. This gets us a step closer to using functional components over class components. The next part of moving to functional components is lifecycle methods.
Effects are similar to componentDidMount, componentDidUpdate, and componentWillUnmount
This is what the Effect Hook is for. Side-effects are things you want your application to do such as:
- Fetch data
- Manually change the DOM (document title)
- Set up a subscription
- Run effects after every render
Running an Effect Hook only when something changes
Since useEffect() runs every time a component renders, how do we get it to only run once on mount? The Effect Hook can take a second argument, an array. It will look through the array and only run the effect if one of the values has changed.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
componentDidMount: Runs once // only run on mount. pass an empty array useEffect(() => { // only runs once }, []); componentDidUpdate: Runs on changes // only run if count changes useEffect( () => { // run here if count changes }, [count] ); |
What about componentWillUnmount()
To run something before a component unmounts, we just have to return a function from useEffect()
Using State and Effects Together
There’s no problem using them together! Together they can create functional components that work the same as your class components!
Open a command prompt. Create a directory for SPFx solution.
md spfx-React-Hooks
Navigate to the newly created directory above.
cd spfx-React-Hooks
Run the Yeoman SharePoint Generator to create the solution.
yo @microsoft/sharepoint
Solution Name
Hit Enter to have default name (spfx-pnp-DropDown in this case) or type in any other name for your solution.
Selected choice – Hit Enter
Target for the component
Here, we can select the target environment where we are planning to deploy the client web part, i.e., SharePoint Online or SharePoint OnPremise (SharePoint 2016 onwards).
Selected choice – SharePoint Online only (latest)
Place of files
We may choose to use the same folder or create a subfolder for our solution.
Selected choice – Same folder
Deployment option
Selecting Y will allow the app to deploy instantly to all sites
Selected choice – N (install on each site explicitly)
Permissions to access web APIs
Choose if the components in the solution require permission to access web APIs that are unique and unshared with other components in the tenant.
Selected choice – N (solution contains unique permissions)
Type of client-side component to create
We can choose to create a client-side web part or an extension. Choose the web part option.
Selected choice – WebPart
Web part name
Hit Enter to select the default name or type in any other name.
Selected choice – SpfxReactHooksCrud
Web part description
Hit Enter to select the default description or type in any other value.
Framework to use
Select any JavaScript framework to develop the component. Available choices are – No JavaScript Framework, React, and Knockout.
Selected choice – React
The yeoman generator will perform a scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.
Once the scaffolding process is completed, lock down the version of the project dependencies by running below command.
npm shrinkwrap
In the command prompt, type the below command to open the solution in the code editor of your choice.
code .
NPM Packages Used,
On the command prompt, run below command.
npm i @pnp/logging @pnp/common @pnp/odata @pnp/sp –save
for Polyfills
npm install –save @pnp/polyfill-ie11
in SpfxReactHooksCrudWebPart.ts,
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
import * as React from 'react'; import * as ReactDom from 'react-dom'; import { Version } from '@microsoft/sp-core-library'; import { BaseClientSideWebPart, IPropertyPaneConfiguration, PropertyPaneTextField } from '@microsoft/sp-webpart-base'; import * as strings from 'SpfxReactHooksCrudWebPartStrings'; import SpfxReactHooksCrud from './components/SpfxReactHooksCrud'; import { ISpfxReactHooksCrudProps } from './components/ISpfxReactHooksCrudProps'; import "@pnp/polyfill-ie11"; import { sp, Web } from '@pnp/sp'; export interface ISpfxReactHooksCrudWebPartProps { description: string; } export default class SpfxReactHooksCrudWebPart extends BaseClientSideWebPart<ISpfxReactHooksCrudWebPartProps> { protected onInit(): Promise<void> { return new Promise<void>((resolve: () => void, reject: (error?: any) => void): void => { sp.setup({ sp: { headers: { "Accept": "application/json; odata=nometadata" } } }); resolve(); }); } public render(): void { const element: React.ReactElement<ISpfxReactHooksCrudProps > = React.createElement( SpfxReactHooksCrud, { description: this.properties.description, context: this.context } ); ReactDom.render(element, this.domElement); } protected onDispose(): void { ReactDom.unmountComponentAtNode(this.domElement); } protected get dataVersion(): Version { return Version.parse('1.0'); } protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration { return { pages: [ { header: { description: strings.PropertyPaneDescription }, groups: [ { groupName: strings.BasicGroupName, groupFields: [ PropertyPaneTextField('description', { label: strings.DescriptionFieldLabel }) ] } ] } ] }; } } |
in HookUsestate.ts
in ISpfxReactHooksCrudProps.ts
|
1 2 3 4 5 |
import {WebPartContext} from '@microsoft/sp-webpart-base'; export interface ISpfxReactHooksCrudProps { description: string; context: WebPartContext; } |
in SpfxReactHooksCrud.tsx
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
import * as React from 'react'; /*import styles from './SpfxReactHooksCrud.module.scss';*/ import { ISpfxReactHooksCrudProps } from './ISpfxReactHooksCrudProps'; import { escape } from '@microsoft/sp-lodash-subset'; import { MyListComponent } from './MyList'; const UserContext = React.createContext([]); export default class SpfxReactHooksCrud extends React.Component<ISpfxReactHooksCrudProps, {}> { public render(): React.ReactElement<ISpfxReactHooksCrudProps> { return ( <div > <MyListComponent /> </div> ); } } |
in MyList.tsx
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
import * as React from 'react'; import { SpListCollection } from './mySpListCollection'; export const MyListComponent = () => { const { datacol, loaddata } = SpListCollection(); React.useEffect(() => { loaddata(); }, []); return ( <div> <DataBinding DataNewCol={datacol} /> </div> ); }; const DataBinding = (props) => { //function DataBinding(props) { const DataNewCol = props.DataNewCol; const listItems = DataNewCol.map((data, index) => <div key={index}> <h3>{data.Title}</h3> <p>{data.MileStone}</p> <p>{data.Id}</p> </div> ); return ( <div>{listItems}</div> ); }; |
in mySpListCOllection.tsx
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
import * as React from 'react'; import { sp } from "@pnp/sp"; import { IHooksuseState } from './HooksuseState'; export const SpListCollection = () => { const [datacol, setdatacol] = React.useState([]); const loaddata = () => { sp.web.lists.getByTitle("ProjectStatus").items.select('Title', 'Id', 'MileStone').get().then((items) => { let result: IHooksuseState[] = []; items.forEach(element => { result.push({ Id: element.Id, Title: element.Title, MileStone: element.MileStone }); }); return result; }) .then(resultdata => setdatacol(resultdata)); }; return { datacol, loaddata, setdatacol }; }; |
Here, I am using “ProjectStatus” as a list name with “MileStone,Id,Title” as Field Names.
SharePoint 2013 Hosting – HostForLIFE.eu :: Creating a BalkanGraph OrgChart with Spfx
Nov 7th
Open a command prompt. Create a directory for SPFx solution.
md spfx-React-BalkanGraphChart
Navigate to the above-created directory.
cd spfx-React-BalkanGraphChart
Run the Yeoman SharePoint Generator to create the solution.
yo @microsoft/sharepoint
Solution Name
Hit Enter for the default name (spfx-pnp-DropDown in this case,) or type in any other name for your solution.
Selected Choice – Hit Enter
Target for the Component
Here, we can select the target environment where we are planning to deploy the client web part, i.e., SharePoint Online or SharePoint OnPremise (SharePoint 2016 onwards).
Selected Choice – SharePoint Online only (latest)
File Location
We may choose to use the same folder or create a subfolder for our solution.
Selected Choice – Same folder
Deployment Option
Selecting Y will allow the app to be deployed instantly to all sites and accessible everywhere.
Selected Choice: N (install on each site explicitly)
Permissions to access Web APIs
Choose if the components in the solution require permissions to access web APIs which are unique and not shared with other components in the tenant.
Selected choice: N (solution contains unique permissions)
Type of client-side component to create
We can choose to create a client-side web part or an extension. Choose the web part option.
Selected Choice – web part
Web part name
Hit Enter to select the default name or type in any other name.
Selected Choice – BalkanOrgChart
Web part description
Hit Enter to select the default description or type in any other value.
Framework to use
Select any JavaScript framework to develop the component. Available choices are – No JavaScript Framework, React, and Knockout.
Selected Choice – React
Yeoman generator will perform a scaffolding process to generate the solution. The scaffolding process will take a significant amount of time.
Once the scaffolding process is completed, lock down the version of project dependencies by running the below command:
npm shrinkwrap
In the command prompt, type below command to open the solution in the code editor of your choice.
code .
In BalkanOrgChart.tsx
System requirements
OrgChart JS will run on any server that supports HTML. You can even run OrgChart.js locally from a filesystem.
OrgChart JS does not depend on any third-party JavaScript library.
OrgChart JS works in all modern browsers and uses SVG for the graphics rendering.
Where…
nodes is the data source. The ‘id’ property is mandatory.
pid is the parent id, this represents a connection between two nodes.
nodeBinding is the ‘name’ property form, the data source will be bound to ‘field_0’ UI element from the template.
