Working with View Properties

Introduction

In PowerPoint documents, view properties refer to the various viewing modes available that allow you to work with your presentation in different ways, depending on your current needs. Use the following methods to get and update the view properties of a presentation.

GetViewProperties

API Information

API	Type	Description	Resource
/slides/{name}/viewProperties	GET	Returns the view properties from a presentation saved in a storage.	GetViewProperties

Request Parameters

Name	Type	Location	Required	Description
name	string	path	true	The name of a presentation file.
password	string	header	false	The password to open the presentation.
folder	string	query	false	The path to the folder containing the presentation file.
storage	string	query	false	The name of the storage contaning the folder.

Examples

Retrieve the view properties from the document MyPresentation.pptx saved in the default storage.

cURL Solution

Request

Get an Access Token

curl -X POST "https://api.aspose.cloud/connect/token" \
     -d "grant_type=client_credentials&client_id=MyClientId&client_secret=MyClientSecret" \
     -H "Content-Type: application/x-www-form-urlencoded"

Get the View Properties

curl -X GET "https://api.aspose.cloud/v3.0/slides/MyPresentation.pptx/viewProperties" \
     -H "authorization: Bearer MyAccessToken"

Response

Response Example

{
  "lastView": "SlideView",
  "horizontalBarState": "Restored",
  "verticalBarState": "Restored",
  "preferSingleView": false,
  "restoredLeft": {
    "autoAdjust": true,
    "dimensionSize": 15.62
  },
  "restoredTop": {
    "autoAdjust": true,
    "dimensionSize": 94.66
  },
  "slideViewProperties": {
    "scale": 93,
    "variableScale": true
  },
  "notesViewProperties": {
    "scale": 1,
    "variableScale": false
  },
  "showComments": "True",
  "selfUri": {
    "href": "https://api.aspose.cloud/v3.0/slides/MyPresentation.pptx/viewProperties",
    "relation": "self"
  }
}

SDK Solutions

using System;
using Aspose.Slides.Cloud.Sdk;
using Aspose.Slides.Cloud.Sdk.Model;

class Application
{
    static void Main(string[] args)
    {
        SlidesApi slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        ViewProperties viewProperties = slidesApi.GetViewProperties("MyPresentation.pptx");

        Console.WriteLine("Horizontal bar state: " + viewProperties.HorizontalBarState);
        Console.WriteLine("Last view: " + viewProperties.LastView);
        Console.WriteLine("Notes view scale: " + viewProperties.NotesViewProperties.Scale);
        Console.WriteLine("Prefer single view: " + viewProperties.PreferSingleView);
        Console.WriteLine("Show comments: " + viewProperties.ShowComments);
        Console.WriteLine("Slide view scale: " + viewProperties.SlideViewProperties.Scale);
        Console.WriteLine("Vertical bar state: " + viewProperties.VerticalBarState);
    }
}

// Example output:
//
// Horizontal bar state: Restored
// Last view: SlideView
// Notes view scale: 1
// Prefer single view: False
// Show comments: True
// Slide view scale: 93
// Vertical bar state: Restored

Java

import com.aspose.slides.ApiException;
import com.aspose.slides.api.SlidesApi;
import com.aspose.slides.model.ViewProperties;

public class Application {
    public static void main(String[] args) throws ApiException {
        SlidesApi slidesApi = new SlidesApi("MyClientId", "MyClientSecret");

        ViewProperties viewProperties = slidesApi.getViewProperties("MyPresentation.pptx", null, null, null);

        System.out.println("Horizontal bar state: " + viewProperties.getHorizontalBarState());
        System.out.println("Last view: " + viewProperties.getLastView());
        System.out.println("Notes view scale: " + viewProperties.getNotesViewProperties().getScale());
        System.out.println("Prefer single view: " + viewProperties.isPreferSingleView());
        System.out.println("Show comments: " + viewProperties.getShowComments());
        System.out.println("Slide view scale: " + viewProperties.getSlideViewProperties().getScale());
        System.out.println("Vertical bar state: " + viewProperties.getVerticalBarState());
    }
}

// Example output:
//
// Horizontal bar state: Restored
// Last view: SlideView
// Notes view scale: 1
// Prefer single view: false
// Show comments: True
// Slide view scale: 93
// Vertical bar state: Restored

PHP

use Aspose\Slides\Cloud\Sdk\Api\Configuration;
use Aspose\Slides\Cloud\Sdk\Api\SlidesApi;

$configuration = new Configuration();
$configuration->setAppSid("MyClientId");
$configuration->setAppKey("MyClientSecret");

$slidesApi = new SlidesApi(null, $configuration);

$viewProperties = $slidesApi->getViewProperties("MyPresentation.pptx");

print("Horizontal bar state: " . $viewProperties->getHorizontalBarState()) . "\r\n";
print("Last view: " . $viewProperties->getLastView() . "\r\n");
print("Notes view scale: " . $viewProperties->getNotesViewProperties()->getScale() . "\r\n");
print("Prefer single view: " . $viewProperties->getPreferSingleView() . "\r\n");
print("Show comments: " . $viewProperties->getShowComments() . "\r\n");
print("Slide view scale: " . $viewProperties->getSlideViewProperties()->getScale() . "\r\n");
print("Vertical bar state: " . $viewProperties->getVerticalBarState() . "\r\n");

// Example output:
//
// Horizontal bar state: Restored
// Last view: SlideView
// Notes view scale: 1
// Prefer single view: 
// Show comments: True
// Slide view scale: 93
// Vertical bar state: Restored

Ruby

require "aspose_slides_cloud"

include AsposeSlidesCloud

configuration = Configuration.new
configuration.app_sid = "MyClientId"
configuration.app_key = "MyClientSecret"

slides_api = SlidesApi.new(configuration)

view_properties = slides_api.get_view_properties("MyPresentation.pptx")

puts "Horizontal bar state: #{view_properties.horizontal_bar_state}"
puts "Last view: #{view_properties.last_view}"
puts "Notes view scale: #{view_properties.notes_view_properties.scale}"
puts "Prefer single view: #{view_properties.prefer_single_view}"
puts "Show comments: #{view_properties.show_comments}"
puts "Slide view scale: #{view_properties.slide_view_properties.scale}"
puts "Vertical bar state: #{view_properties.vertical_bar_state}"

# Example output:
#
# Horizontal bar state: Restored
# Last view: SlideView
# Notes view scale: 1
# Prefer single view: false
# Show comments: True
# Slide view scale: 93
# Vertical bar state: Restored

Python

from asposeslidescloud.apis import SlidesApi

slides_api = SlidesApi(None, "MyClientId", "MyClientSecret")

view_properties = slides_api.get_view_properties("MyPresentation.pptx")

print("Horizontal bar state:", view_properties.horizontal_bar_state)
print("Last view:", view_properties.last_view)
print("Notes view scale:", view_properties.notes_view_properties.scale)
print("Prefer single view:", view_properties.prefer_single_view)
print("Show comments:", view_properties.show_comments)
print("Slide view scale:", view_properties.slide_view_properties.scale)
print("Vertical bar state:", view_properties.vertical_bar_state)

# Example output:
#
# Horizontal bar state: Restored
# Last view: SlideView
# Notes view scale: 1
# Prefer single view: False
# Show comments: True
# Slide view scale: 93
# Vertical bar state: Restored

Node.js

const cloudSdk = require("asposeslidescloud");

const slidesApi = new cloudSdk.SlidesApi("MyClientId", "MyClientSecret");

slidesApi.getViewProperties("MyPresentation.pptx").then(viewProperties => {
    console.log("Horizontal bar state:", viewProperties.body.horizontalBarState);
    console.log("Last view:", viewProperties.body.lastView);
    console.log("Notes view scale:", viewProperties.body.notesViewProperties.scale);
    console.log("Prefer single view:", viewProperties.body.preferSingleView);
    console.log("Show comments:", viewProperties.body.showComments);
    console.log("Slide view scale:", viewProperties.body.slideViewProperties.scale);
    console.log("Vertical bar state:", viewProperties.body.verticalBarState);
});

// Example output:
//
// Horizontal bar state: Restored
// Last view: SlideView
// Notes view scale: 1
// Prefer single view: false
// Show comments: True
// Slide view scale: 93
// Vertical bar state: Restored

C++

#include "asposeslidescloud/api/SlidesApi.h"

using namespace asposeslidescloud::api;

int main()
{
    std::shared_ptr<SlidesApi> slidesApi = std::make_shared<SlidesApi>(L"MyClientId", L"MyClientSecret");

    std::shared_ptr<ViewProperties> viewProperties = slidesApi->getViewProperties(L"MyPresentation.pptx").get();

    std::wcout << L"Horizontal bar state: " << viewProperties->getHorizontalBarState() << std::endl;
    std::wcout << L"Last view: " << viewProperties->getLastView() << std::endl;
    std::wcout << L"Notes view scale: " << viewProperties->getNotesViewProperties()->getScale() << std::endl;
    std::wcout << L"Prefer single view: " << viewProperties->isPreferSingleView() << std::endl;
    std::wcout << L"Show comments: " << viewProperties->getShowComments() << std::endl;
    std::wcout << L"Slide view scale: " << viewProperties->getSlideViewProperties()->getScale() << std::endl;
    std::wcout << L"Vertical bar state: " << viewProperties->getVerticalBarState() << std::endl;
}

// Example output:
//
// Horizontal bar state: Restored
// Last view: SlideView
// Notes view scale: 1
// Prefer single view: 0
// Show comments: True
// Slide view scale: 93
// Vertical bar state: Restored

Perl

use AsposeSlidesCloud::Configuration;
use AsposeSlidesCloud::SlidesApi;

my $configuration = AsposeSlidesCloud::Configuration->new();
$configuration->{app_sid} = "MyClientId";
$configuration->{app_key} = "MyClientSecret";

my $slides_api = AsposeSlidesCloud::SlidesApi->new(config => $configuration);

my $view_properties = $slides_api->get_view_properties(name => "MyPresentation.pptx");

print "Horizontal bar state: $view_properties->{horizontal_bar_state}\n";
print "Last view: $view_properties->{last_view}\n";
print "Notes view scale: $view_properties->{notes_view_properties}{scale}\n";
print "Prefer single view: $view_properties->{prefer_single_view}\n";
print "Show comments: $view_properties->{show_comments}\n";
print "Slide view scale: $view_properties->{slide_view_properties}{scale}\n";
print "Vertical bar state: $view_properties->{vertical_bar_state}\n";

# Example output:
#
# Horizontal bar state: Restored
# Last view: SlideView
# Notes view scale: 1
# Prefer single view: 0
# Show comments: True
# Slide view scale: 93
# Vertical bar state: Restored

import (
	"fmt"

	asposeslidescloud "github.com/aspose-slides-cloud/aspose-slides-cloud-go/v24"
)

func main() {
	configuration := asposeslidescloud.NewConfiguration()
	configuration.AppSid = "MyClientId"
	configuration.AppKey = "MyClientSecret"

	slidesApi := asposeslidescloud.NewAPIClient(configuration).SlidesApi

	viewProperties, _, _ := slidesApi.GetViewProperties("MyPresentation.pptx", "", "", "")

	fmt.Println("Horizontal bar state:", viewProperties.GetHorizontalBarState())
	fmt.Println("Last view:", viewProperties.GetLastView())
	fmt.Println("Notes view scale:", viewProperties.GetNotesViewProperties().GetScale())
	fmt.Println("Prefer single view:", viewProperties.GetPreferSingleView())
	fmt.Println("Show comments:", viewProperties.GetShowComments())
	fmt.Println("Slide view scale:", viewProperties.GetSlideViewProperties().GetScale())
	fmt.Println("Vertical bar state:", viewProperties.GetVerticalBarState())
}

// Example output:
//
// Horizontal bar state: Restored
// Last view: SlideView
// Notes view scale: 1
// Prefer single view: false
// Show comments: True
// Slide view scale: 93
// Vertical bar state: Restored

SetViewProperties