ProConcepts Presentations - Esri/arcgis-pro-sdk GitHub Wiki

//Reference a presentation associated with an active presentation view
PresentationView activePresentation View = PresentationView.Active;
if (activePresentationView != null)
{
  Presentation presentation= activePresentationView.Presentation;
}

//Reference a presentation associated with a presentation project item
PresentationProjectItem presentationItem = Project.Current.GetItems<PresentationProjectItem>()
                                             .FirstOrDefault(item => item.Name.Equals("Some Presentation Name"));
if (presentationItem!= null){
      //Get the presentation associated with the presentationItem
      Presentation presentation= await QueuedTask.Run(() => presentationItem.GetPresentation()); 
      //Create the new pane - must be called on UI
      IPresentationPane InewPresentationPane = await ProApp.Panes.CreatePresentationPaneAsync(presentation);
}

QueuedTask.Run(() =>
{
  //Create a new presentation without parameters
  var newPresentation = PresentationFactory.Instance.CreatePresentation ();
  ...
  // Create a presentation specifying the name of the new presentation
  var newPresentation = PresentationFactory.Instance.CreatePresentation("New Presentation");
  ...
});

//Assume we want to open a view for a particular presentation or activate a view if one is already open

//A presentation project item is an item that appears in the Presentation folder in the Catalog pane.
PresentationProjectItem presentationItem = Project.Current.GetItems<PresentationProjectItem>()
                                             .FirstOrDefault(item => item.Name.Equals("Some Presentation Name"));

//Reference a presentation associated with a presentation project item
if (presentationItem != null)
{
  //Get the presentation associated with the presentationItem
  Presentation presentation = await QueuedTask.Run(() => presentationItem.GetPresentation());

  //Next check to see if a presentation view is already open that references the presentation
  foreach (var pane in ProApp.Panes)
  {
        var prePane = pane as IPresentationPane;
        if (prePane == null)  //if not a presentation view, continue to the next pane
          continue;

        //if there is a match, activate the view
        if (prePane.PresentationView.Presentation == presentation) 
        {
          (prePane as Pane).Activate();
           return;
        }
   }

  //No pane found, activate a new one - must be called on UI
  IPresentationPane InewPresentationPane = await ProApp.Panes.CreatePresentationPaneAsync(presentation);
}

var presentation = PresentationView.Active.Presentation;
//Must be on QueuedTask
QueuedTask.Run(()=> {
   // create a blank page using PresentationPageFactory 
   PresentationPageFactory.Instance.CreateBlankPage(presentation,-1); // index =-1 means add the page to the end of the page collection in a presentation
   ...
});

var presentation = PresentationView.Active.Presentation;
//Must be on QueuedTask
QueuedTask.Run(()=> {
   // add a blank page with with title and paragraph body text element
   presentation.AddBlankPage(BlankPageTemplateType.TitleAndParagraph, -1);
});

var presentation = PresentationView.Active.Presentation;
//Must be on QueuedTask
QueuedTask.Run(()=> {
   // add a new image page in current active presentation
   var imagePage = presentation.AddImagePage("my image source", -1);
   ...
   // change the image source
   imagePage.SetImageSource("new image source");
});

var presentation = PresentationView.Active.Presentation;
//Must be on QueuedTask
QueuedTask.Run(()=> {
   // add a new video page in current active presentation
   var videoPage = presentation.AddVideoPage("my video file", -1);
   ...
   // change the image source
   videoPage.SetVideoSource("new video source");
   ...
// change the start time of video to 3s
videoPage.SetStartTime(3.0);
// change the end time of video to 10s
videoPage.SetEndTime(10.0);
});

var presentation = PresentationView.Active.Presentation;
//Must be on QueuedTask
QueuedTask.Run(()=> {
    // retrieve a map from the project based on the map name
   MapProjectItem mpi = proj.GetItems<MapProjectItem>()
                              .FirstOrDefault(m => m.Name.Equals("Your Map Name", StringComparison.CurrentCultureIgnoreCase)); 
   Map map = mpi.GetMap();
   //create a map page using map's default extent
   presentation.AddMapPage(map, -1);
   
   //create a page using map's bookmark
   Bookmark bookmark = map.GetBookmarks().FirstOrDefault(
                b => b.Name == "Your bookmark"); // get the bookmark based on the bookmark's name
   presentation.AddMapPage(bookmark , -1);
   
});

//Must be on the QueuedTask
QueuedTask.Run(() =>
{
  //Reference a map page
  var mpage= activePresentationView.Presentation.GetPage(4) as MapPresentationPage;

  //Set the map frame extent based on the new camera's X,Y, Scale and heading values
  Camera cam = new Camera(329997.6648, 6248553.1457, 2403605.8968, 24);
  mpage.SetCamera(cam);
});

//Must be on the QueuedTask
QueuedTask.Run(() =>
{
  //Reference map page
  var mpage= activePresentationView.Presentation.GetPage(4) as MapPresentationPage;

  //Reference map and layer
  MapProjectItem mp = Project.Current.FindItem(mp) as MapProjectItem;
  Map map= mp.GetMap();
  FeatureLayer lyr = map.FindLayers("GreatLakes").First() as FeatureLayer;

  //Set the map frame extent to all features in the layer
  mpage.SetCamera(lyr);
});

//a presentation view must be active
if (PresentationView.Active == null)
        return;
PresentationPage activePage = activePresentationView.ActivePage;

//check if the current page is a map page
//Note: we are on the UI thread!
if (activePage is MapPresentationPage)
{
  activePresentationView.ActivateMapPageAsync();
}

//move to the QueuedTask to do something
QueuedTask.Run(() => {
      TODO
});
        

// create customized margin and color 
CIMMargin pMargin = new CIMMargin() { Left = 0.2, Right = 0.3, Top = 0.15, Bottom = 0.25 };
CIMRGBColor pColor = new CIMRGBColor() { R = 255, G = 255, B = 0, Alpha = 50 };

//Reference a page and its transition 
var page= activePresentationView.Presentation.GetPage(0);
CIMPresentationTransition transition = page.Transition;

// update the transition style
transition.TransitionType = PresentationTransitionType.Swipe;
transition.Duration = 2.0;
transition.SwipeDirection = SwipeDirection.Top;

//Must be on the QueuedTask
QueuedTask.Run(() =>
{
  //Set the new margin, new background color and new transition effect
  page.SetMargin(pMargin);
  page.SetBackgroundColor(pColor);
  page.SetTransition(transition);
});

//Must be on QueuedTask
QueuedTask.Run(() =>
 {
   //create a picture element
   
   var imgPath = @"https://www.esri.com/content/dam/esrisites/en-us/home/" +
    "homepage-tile-podcast-business-resilience-climate-change.jpg";

   //Build a geometry to place the picture
   Coordinate2D ll = new Coordinate2D(3.5, 1);
   Coordinate2D ur = new Coordinate2D(6, 5);
   Envelope env = EnvelopeBuilderEx.CreateEnvelope(ll, ur);
   //create a picture element on the page
   var gElement = PresentationElementFactory.Instance.CreatePictureGraphicElement(page, env, imgPath);

   //create a text element

   //Set symbology, create and add element to a presentation page
   CIMTextSymbol sym = SymbolFactory.Instance.ConstructTextSymbol(
                 ColorFactory.Instance.RedRGB, 15, "Arial", "Regular");
   //use ElementInfo to set placement properties
   var elemInfo = new ElementInfo()
   {
     Anchor = Anchor.CenterPoint,
     Rotation = 45
   };
   string textString = "My text";
   var textPos = new Coordinate2D(5, 3).ToMapPoint();
   var tElement = PresentationElementFactory.Instance.CreateTextGraphicElement(page,
     TextType.PointText, textPos, sym, textString, "telement", false, elemInfo);

   //create a group element with elements created above
   var elmList = new List<Element> { gElement, tElement };
   GroupElement grp1 = PresentationElementFactory.Instance.CreateGroupElement(page, elmList, "My Group");
 });

// reference current active page
PresentationPage activePage = PresentationView.Active.ActivePage;

//Must be on QueuedTask
QueuedTask.Run(() => {
     // Find specific elements by name
     var ge_rect = page.FindElement("Rectangle") as GraphicElement;
     var elems = page.FindElements(new List<string>() { "Text, "Polygon" });

     //Get elements retaining hierarchy
     var top_level_elems = page.GetElements();

     //Flatten hierarchy
     var all_elems = page.GetFlattenedElements();

     //Use LINQ with any of the collections
     //Retrieve just those elements that are Visible
     var some_elems = all_elems.Where(ge => ge.IsVisible).ToList();
});

// reference current active presentation view
PresentationView activeView = PresentationView.Active

//Must be on QueuedTask
QueuedTask.Run(() => {
   //Select/unselect some elements...
   var elems = activeView.GetFlattenedElements();
   //select any element not a group element
   elems.SelectElements(elems.Where(e => !e.Name.StartsWith("Group")));
   elems.UnSelectElements(elems.Where(e => !e.Name.StartsWith("Group")));

   //Select/unselect all visible, graphic elements
   var ge_elems = all_elems.Where(ge => ge.IsVisible).ToList();
   activeView .SelectElements(ge_elems);
   activeView.UnSelectElements(ge_elems);

   //Select/unselect a specific element
   var na = activeView.FindElement("My Text Element");
   activeView.SelectElement(na);
   activeView.UnSelectElement(na);

   //Select everything
   activePage.SelectElements(elems);

   //enumerate the selected elements
   foreach(var sel_elem in activeView.GetSelectedElements()) {
     //TODO
});

 //Detect changes to the presentation modifications - listen for the relevant hint
  ArcGIS.Desktop.Presentations.Events.PresentationEvent.Subscribe((args) => {
    var presentation = args.Presentation; //The presentation that was changed

    //Check what triggered the event and take appropriate action
    switch (args.Hint) {
      case PresentationEventHint.PropertyChanged:
        //TODO handle presentation property changed
        break;
      case PresentationEventHint.PageAdded:
        //TODO handle a new page added
        break;
      case PresentationEventHint.PageRemoved:
        //TODO handle a page removed from the presentation
        break;
      case PresentationEventHint.PageSettingChanged:
        //TODO handle page settings changed
        break;
    }
 });

//For UI context changes associated with a presentation, subscribe to the PresentationView
 //event - views activated/deactivated, views opened/closed
 ArcGIS.Desktop.Presentations.Events.PresentationViewEvent.Subscribe((args) =>
  //get the affected view and presentation
  var view = args.PresentationView;
  var presentation = args.PresentationView?.Presentation;
  if (presentation == null) {
     //FYI presentationview and/or presentation can be null...
     //eg closed, deactivation
  }
  //Check what triggered the event and take appropriate action
  switch (args.Hint) {
    case PresentationViewEventHint.Activated:
      //presentation view closed
      break;
    case PresentationViewEventHint.Opened:
      //A PresentationView has been initialized
      break;
    case PresentationViewEventHint.Activated:
      break;
    case PresentationViewEventHint.Deactivated:
      break;
    case PresentationViewEventHint.Closing:
      //Set args.Cancel = true to prevent closing
      break;
    case PresentationViewEventHint.ExtentChanged:
      //presentation view extent has changed
      break;
    case PresentationViewEventHint.DrawingComplete:
      break;
    case PresentationViewEventHint.PauseDrawingChanged:
      break;
  }
});

//On QueuedTask
//var presentation = ...;

//Create mp4 format with appropriate settings
MP4VideoFormat mp4Format = new MP4VideoFormat();
mp4Format.Width = 800;
mp4Format.Height = 600;
mp4Format.OutputFileName = @"my folder\presentation.mp4";

//Define Export Options
PresentationExportOptions options = new PresentationExportOptions {
    PageRangeOption = ExportPageOptions.ExportByPageRange,
    CustomPages = "1,2,8"
};

//export as mp4
presentation.Export(mp4Format, options);